Add README

This commit is contained in:
Tanner Collin 2023-03-07 22:45:23 -07:00
parent 612c881240
commit 319d7373d8

32
README.md Normal file
View File

@ -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.