From 8ad2354b7c2a18b8dbbed7dc2b1a519a0fc8428b Mon Sep 17 00:00:00 2001 From: Benjamen Meyer Date: Mon, 13 Jan 2025 00:58:07 -0500 Subject: [PATCH] Enhancement: Minimize Download Size Document how others can minimize downloads, specifically for maintainers of systems like Gentoo, Arch, etc. Closes #83 --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index ce0e0dc04d..1ae0cc8af3 100644 --- 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: