From 6687d30ba57530a7912143557dc24626c81ffd40 Mon Sep 17 00:00:00 2001 From: Jax Calder Date: Wed, 28 Oct 2026 19:25:04 +0000 Subject: [PATCH] docs: clone dmod with its submodules Since dmod#341 the compression library (dmcomp) is a git submodule, and a clone without it cannot be configured. The installation guide (Option B) clones with --recursive, and the READMEs of the library and application templates, which suggest a local checkout with -DDMOD_DIR, say that the checkout needs its submodules. Co-Authored-By: Claude Sonnet 5.5 --- .github/templates/application/README.md.template | 3 ++- .github/templates/library/README.md.template | 3 ++- docs/tools-installation.md | 2 +- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/templates/application/README.md.template b/.github/templates/application/README.md.template index efe8ba22..1ded5b84 100644 --- a/.github/templates/application/README.md.template +++ b/.github/templates/application/README.md.template @@ -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 diff --git a/.github/templates/library/README.md.template b/.github/templates/library/README.md.template index 97e533a0..44c9d62a 100644 --- a/.github/templates/library/README.md.template +++ b/.github/templates/library/README.md.template @@ -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 diff --git a/docs/tools-installation.md b/docs/tools-installation.md index a21349de..0e512f1f 100644 --- a/docs/tools-installation.md +++ b/docs/tools-installation.md @@ -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/