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/