Skip to content

Commit 1bb8028

Browse files
committed
docs(build): new "System Requirements for Compiling" section
Highlights memory (8GiB+) and disk space (15GiB SSD) requirements, insights gained from trying to compile SnapX on some leaner Linux virtual machines. Hopefully, this saves others some headaches!
1 parent 67ff79b commit 1bb8028

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,13 @@ exec $SHELL -l
176176
>
177177
> On **macOS**, it's `~/Library/Application Support/SnapX`
178178
179+
### System Requirements for Compiling
180+
181+
To successfully compile SnapX from source, ensure your system meets the following requirements:
182+
183+
* **Memory (RAM):** A minimum of 8GiB free memory is required during the compilation process.
184+
* **Disk Space:** At least 15 GiB of free disk space is recommended, preferably on a Solid State Drive (SSD) for optimal compilation speed.
185+
179186
```bash
180187
git clone https://github.com/BrycensRanch/SnapX
181188
cd SnapX

0 commit comments

Comments
 (0)