aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDevan Carpenter <git@dvn.me>2019-01-05 22:40:02 -0600
committerDevan Carpenter <git@dvn.me>2019-01-05 22:40:02 -0600
commitbb6c9aeabca352b2c92f456de144a1dbfa76df53 (patch)
tree22a31287689664708b4dd1e816e51fc7ccff51a6
parent4ee04b58ca8070f468442c8d9841825b151ddf40 (diff)
downloadwww-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--README13
1 files changed, 11 insertions, 2 deletions
diff --git a/README b/README
index d554fce9..eb46716e 100644
--- a/README
+++ b/README
@@ -25,9 +25,18 @@ This can be achieved with the following command:
25After installing the packages, this will drop you into a bash environment 25After installing the packages, this will drop you into a bash environment
26from which you can proceed to run "make". 26from which you can proceed to run "make".
27 27
28Alternative Build Method: Docker
29================================
28 30
29Notes 31Run "make docker" to generate the HTML using a docker container-image (which
30===== 32will be built from the included ./Dockerfile).
33
34This could be useful if, for example, you are unable to install the required
35packages on your system, because it will use the container to install and run
36all of the required packages.
37
38Additional Notes
39================
31 40
32This website has been tested with python 3.6.5 and jinja2 2.9.6. 41This website has been tested with python 3.6.5 and jinja2 2.9.6.
33Since python development in collaborative environments with 42Since python development in collaborative environments with