diff --git a/README.md b/README.md new file mode 100644 index 0000000..9dddbc9 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Solarpunk City + +## Development + +After cloning the repo: + +``` +$ cd solarpunkcity/ +$ virtualenv -p python3 env +$ source env/bin/activate +(env) $ pip install -r requirements.txt +``` + +While editing: + +``` +$ source env/bin/activate +(env) $ pelican -rl -s pelicanconf.py +``` + +To deploy: + +``` +$ source env/bin/activate +(env) $ pelican -d -s publishconf.py && rsync -rv --delete output/ solarpunkcity.org:/var/www/solarpunkcity/ +``` + +## Editing + +Edit `.md` files in the `content/` directory. + +Place all media in the `content/media/` directory. Pelican will automatically find it.