Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 28 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down