Skip to content

docs: clone dmod with its submodules #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnAmadis merged 1 commit into from
Oct 28, 2026
Merged

docs: clone dmod with its submodules #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion .github/templates/application/README.md.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ cmake --build .
```

Pass `-DDMOD_DIR=/path/to/local/dmod` to build against a local dmod checkout
instead of fetching `develop` from GitHub.
instead of fetching `develop` from GitHub. The checkout needs its submodules (dmod keeps its compression
library in one): `git clone --recursive`, or `git submodule update --init --recursive` in an existing one.

### Using Make

Expand Down
3 changes: 2 additions & 1 deletion .github/templates/library/README.md.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ cmake --build .
```

Pass `-DDMOD_DIR=/path/to/local/dmod` to build against a local dmod checkout
instead of fetching `develop` from GitHub.
instead of fetching `develop` from GitHub. The checkout needs its submodules (dmod keeps its compression
library in one): `git clone --recursive`, or `git submodule update --init --recursive` in an existing one.

### Using Make

Expand Down
2 changes: 1 addition & 1 deletion docs/tools-installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,7 @@ docker pull chocotechnologies/dmod:1.0.4
docker run -it -v $(pwd):/workspace -w /workspace chocotechnologies/dmod:1.0.4 bash

# Option B: Install tools locally
git clone https://github.com/choco-technologies/dmod.git
git clone --recursive https://github.com/choco-technologies/dmod.git
cd dmod
cmake -DDMOD_MODE=DMOD_SYSTEM -DDMOD_BUILD_TOOLS=ON -B build -S .
cmake --build build/
Expand Down
Loading