From 47cc7c6fcc6d674b5885549de042ddcf16c15f27 Mon Sep 17 00:00:00 2001 From: RDW Date: Wed, 1 Oct 2025 19:32:17 +0200 Subject: [PATCH] List some more efficient checkout methods in the README --- README.MD | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.MD b/README.MD index dd72ee2..37de61c 100644 --- a/README.MD +++ b/README.MD @@ -14,7 +14,34 @@ Make sure to check out the repository *recursively* since it uses [Git submodule git clone https://github.com/RagnarokResearchLab/CommunityProjects.git --recursive ``` -Be aware that *all* dependencies will be fetched, some of which are quite large. Several gigabytes of hard disk space will be consumed. +Be aware that *all* dependencies will be fetched, some of which are quite large (several gigabytes). + +If you aren't interested in getting the complete commit history, you can speed up this process: + +```bash +git clone https://github.com/RagnarokResearchLab/CommunityProjects.git --recursive --shallow-submodules +``` + +To further reduce the time needed to clone, you may want to skip nested dependencies as well: + +```bash +git clone https://github.com/RagnarokResearchLab/CommunityProjects.git --shallow-submodules +``` + +Finally, you could override the parallelism factor, which defaults to an overly conservative value: + +```bash +git clone https://github.com/RagnarokResearchLab/CommunityProjects.git --shallow-submodules --jobs=8 +``` + +The difference will be quite signitifcant, as shown by the following comparison table: + +| Recursive | Shallow | Jobs | Time | Disk Usage | +| :---: | :---: | :---: | :---: | :---: | +| NO | NO | 0 (auto) | 0.929 sec | 246 KB | +| YES | NO | 0 (auto) | 8 min 4 sec | 4.8 GB | +| YES | YES | 8 | 3 min 58 sec | 3.1 GB | +| YES | YES | 0 (auto) | 5 min 56 sec | 3.1 GB | ## Licensing Information