aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRaven Szewczyk <git@eigenraven.me>2024-05-25 13:57:34 +0100
committerRaven Szewczyk <git@eigenraven.me>2024-05-25 13:57:34 +0100
commit13d47567b6b1103647e5a819e601b426911bb89d (patch)
tree0bef4b35fccc45651157f0ebca021eeff1939182 /README.md
parent439c6ded54865c9e61f34fd6fb84fb5cc9576ef5 (diff)
downloadGT5-Unofficial-13d47567b6b1103647e5a819e601b426911bb89d.tar.gz
GT5-Unofficial-13d47567b6b1103647e5a819e601b426911bb89d.tar.bz2
GT5-Unofficial-13d47567b6b1103647e5a819e601b426911bb89d.zip
Add a note about shallow clones to the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index 968c8f1738..ceb985caa5 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,12 @@ as version and steps to reproduce.
Please do! However, please take a note of
[current issues](https://github.com/GTNewHorizons/GT-New-Horizons-Modpack/issues) and what is currently being worked on.
+You don't need to clone the repository with full history to contribute, to save disk space and bandwidth you can clone:
+```bash
+git clone --depth 3 https://github.com/GTNewHorizons/GT5-Unofficial.git GT5-Unofficial
+```
+This way you'll get the last 3 commits of history in your local checkout, instead of all of it.
+
It is suggested to run `./gradlew build` inside your cloned repository before importing it to your IDE. This will reduce
the chance of strange errors.