Update README instructions and add .gitignore
authorJonathan S. Katz <jonathan.katz@excoventures.com>
Thu, 21 Jan 2021 16:40:17 +0000 (11:40 -0500)
committerJonathan S. Katz <jonathan.katz@excoventures.com>
Thu, 21 Jan 2021 16:40:17 +0000 (11:40 -0500)
The README instructions are simplified slightly for setting up
the virtual environment.

A .gitignore entry is also added to coincide with one of the
README instructions, i.e. creating the virtual environment
directory within the repository.

.gitignore
README.md

index 723ef36f4e4f32c4560383aa5987c575a30c6535..84f91b135547e4acd8119529e47fcee5ed71f9e6 100644 (file)
@@ -1 +1,2 @@
-.idea
\ No newline at end of file
+.idea
+pythonenv
index 8e7a1a0e0a3a0af6688eb0bde796dd1968ff3d66..0191c6db9850885db8d70e824b4b662de4fdd786 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,26 +3,24 @@ 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 
+2. git clone https://git.postgresql.org/git/pgeu-website.git
 3. Setup a python virtualenv:
 
     ```shell script
-    python3 -m venv pythonenv 
+    python3 -m venv pythonenv
     . pythonenv/bin/activate
-    pip3 install Markdown==2.6.5
-    pip3 install python-dateutil
-    pip3 install jinja2
+    pip install Markdown==2.6.5 python-dateutil jinja2
     ```
 
 4. Run the deploystatic.py script:
 
     ```shell script
-    python3 pgeu-website/tools/deploystatic/deploystatic.py `pwd`/pgcac-website `pwd`/postgres.ca
+    python 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
+    python -m http.server
     ```