aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index a5979ee..25b3a44 100644
--- a/README.md
+++ b/README.md
@@ -183,6 +183,19 @@ cargo build --release
183 183
184From now on you can make changes to the `README.md` file and use your latest compiled version of `pangler` to tangle and compile it. 184From now on you can make changes to the `README.md` file and use your latest compiled version of `pangler` to tangle and compile it.
185 185
186### Using Docker
187
188An alternative way to compile the project is using Docker.
189Run the following from the root of the project without the need to install Rust locally.
190
191```sh
192docker run --rm --user "$(id -u)":"$(id -g)" -v "$PWD":/usr/src/pangler -w /usr/src/pangler rust:latest cargo build --release
193```
194
195See the [official documentation](https://hub.docker.com/_/rust) for more information.
196
197The executable will be in `target/release/pangler`.
198
186## Weaving: generating the documentation 199## Weaving: generating the documentation
187 200
188As explained above we use [`pandoc`](https://pandoc.org/) as a weaver. 201As explained above we use [`pandoc`](https://pandoc.org/) as a weaver.