diff options
author | Devan Carpenter <git@dvn.me> | 2019-01-05 22:40:02 -0600 |
---|---|---|
committer | Devan Carpenter <git@dvn.me> | 2019-01-05 22:40:02 -0600 |
commit | bb6c9aeabca352b2c92f456de144a1dbfa76df53 (patch) | |
tree | 22a31287689664708b4dd1e816e51fc7ccff51a6 | |
parent | 4ee04b58ca8070f468442c8d9841825b151ddf40 (diff) | |
download | www-bb6c9aeabca352b2c92f456de144a1dbfa76df53.tar.gz www-bb6c9aeabca352b2c92f456de144a1dbfa76df53.zip |
README: add documentation about alternative build
This documents how to use the alternative docker-based process for
building the HTML. Additionally, I have added some information as to why
one might want to use this.
-rw-r--r-- | README | 13 |
1 files changed, 11 insertions, 2 deletions
@@ -25,9 +25,18 @@ This can be achieved with the following command: | |||
25 | After installing the packages, this will drop you into a bash environment | 25 | After installing the packages, this will drop you into a bash environment |
26 | from which you can proceed to run "make". | 26 | from which you can proceed to run "make". |
27 | 27 | ||
28 | Alternative Build Method: Docker | ||
29 | ================================ | ||
28 | 30 | ||
29 | Notes | 31 | Run "make docker" to generate the HTML using a docker container-image (which |
30 | ===== | 32 | will be built from the included ./Dockerfile). |
33 | |||
34 | This could be useful if, for example, you are unable to install the required | ||
35 | packages on your system, because it will use the container to install and run | ||
36 | all of the required packages. | ||
37 | |||
38 | Additional Notes | ||
39 | ================ | ||
31 | 40 | ||
32 | This website has been tested with python 3.6.5 and jinja2 2.9.6. | 41 | This website has been tested with python 3.6.5 and jinja2 2.9.6. |
33 | Since python development in collaborative environments with | 42 | Since python development in collaborative environments with |