diff options
| author | Federico Igne <git@federicoigne.com> | 2022-12-30 16:22:31 +0000 |
|---|---|---|
| committer | Federico Igne <git@federicoigne.com> | 2022-12-30 16:22:31 +0000 |
| commit | 0168e6717641cb16c786eb20bd0d05dcd4911599 (patch) | |
| tree | e70beed3ead10f71cde428d2dee01717e0e6afd0 | |
| parent | d27d5e9094f0f5916266e0460ff0877ef330bd2d (diff) | |
| download | pangler-0168e6717641cb16c786eb20bd0d05dcd4911599.tar.gz pangler-0168e6717641cb16c786eb20bd0d05dcd4911599.zip | |
docs: add instructions to compile project with Docker
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
| @@ -183,6 +183,19 @@ cargo build --release | |||
| 183 | 183 | ||
| 184 | From now on you can make changes to the `README.md` file and use your latest compiled version of `pangler` to tangle and compile it. | 184 | From 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 | |||
| 188 | An alternative way to compile the project is using Docker. | ||
| 189 | Run the following from the root of the project without the need to install Rust locally. | ||
| 190 | |||
| 191 | ```sh | ||
| 192 | docker run --rm --user "$(id -u)":"$(id -g)" -v "$PWD":/usr/src/pangler -w /usr/src/pangler rust:latest cargo build --release | ||
| 193 | ``` | ||
| 194 | |||
| 195 | See the [official documentation](https://hub.docker.com/_/rust) for more information. | ||
| 196 | |||
| 197 | The executable will be in `target/release/pangler`. | ||
| 198 | |||
| 186 | ## Weaving: generating the documentation | 199 | ## Weaving: generating the documentation |
| 187 | 200 | ||
| 188 | As explained above we use [`pandoc`](https://pandoc.org/) as a weaver. | 201 | As explained above we use [`pandoc`](https://pandoc.org/) as a weaver. |
