Add a README describing how to build and test the site.
authorSteve Singer <steve@ssinger.info>
Mon, 6 Jul 2020 09:37:04 +0000 (10:37 +0100)
committerDave Page <dpage@pgadmin.org>
Mon, 6 Jul 2020 09:37:04 +0000 (10:37 +0100)
Steve Singer, with additional work from me.

README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..8e7a1a0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+The PGCAC website is based on the pgeu-website template engine.
+
+A static website can be generated from these templates with the following steps:
+
+1. git clone https://git.postgresql.org/git/pgcac-website.git
+2. git clone https://git.postgresql.org/git/pgeu-website.git 
+3. Setup a python virtualenv:
+
+    ```shell script
+    python3 -m venv pythonenv 
+    . pythonenv/bin/activate
+    pip3 install Markdown==2.6.5
+    pip3 install python-dateutil
+    pip3 install jinja2
+    ```
+
+4. Run the deploystatic.py script:
+
+    ```shell script
+    python3 pgeu-website/tools/deploystatic/deploystatic.py `pwd`/pgcac-website `pwd`/postgres.ca
+    ```
+
+5. Test the resulting build:
+
+    ```shell script
+    cd postgres.ca
+    python3 -m http.server
+    ```