Merge branch 'master' into fix/index_out_of_bounds_2025-01-11

stephengtuggy · Jan 14, 2025 · 6e4decc · 6e4decc
2 parents 4cd3f7d + dfdd56d
commit 6e4decc
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -126,6 +126,21 @@ If you encounter any issues while playing, please create an issue with the Vega
 
 # Compiling Vegastrike
 
+## Saving some space while downloading
+
+The Vega Strike Engine Source repository contains a lot of history not all of which is relevant to current developers if they want to quickly download and build something.
+By default, the full clone will download over 800 MB of data. There are several options to minimize this:
+
+1. Download a compressed copy of the source from the release
+2. Download a master.zip from GitHub
+3. Do a shallow clone using the following:
+
+```bash
+$ git clone git@github.com:vegastrike/Vega-Strike-Engine-Source.git --shallow-since=2023-09-27
+```
+
+This will produce a significantly smaller download - in the order of 22-30 MB; well over a 10x reduction.
+
 ## Compiling On Linux
 
 1. Install the development dependencies: