[Doc] readme update for makefile
This commit is contained in:
42
README.md
42
README.md
@@ -2,41 +2,59 @@
|
|||||||
|
|
||||||
dmz.rs/decentrala.org website
|
dmz.rs/decentrala.org website
|
||||||
|
|
||||||
## Build site
|
## Setup
|
||||||
|
|
||||||
Run
|
First, prepare the virtual environment and install dependencies:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
python atom_gen.py
|
make prep
|
||||||
python prep.py
|
|
||||||
python build_pages.py
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Complete website will be contained in `site/`. You can copy this to server.
|
## Build site
|
||||||
|
|
||||||
|
To build the complete website:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
make build
|
||||||
|
```
|
||||||
|
|
||||||
|
The complete website will be contained in `site/`. You can copy this to your server.
|
||||||
|
|
||||||
## Development server
|
## Development server
|
||||||
|
|
||||||
To start a development server, first build site, then run (possibly with `sudo`)
|
To start a development server, first build the site, then run (possibly with `sudo`):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
nginx -p . -c nginx.dev.conf
|
make dev
|
||||||
```
|
```
|
||||||
|
|
||||||
To stop it:
|
To stop it:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
nginx -p . -s stop
|
make stop
|
||||||
```
|
```
|
||||||
|
|
||||||
## Events
|
## Events
|
||||||
|
|
||||||
To update events, update the `events.csv` then run commands
|
To update events, update `dogadjaji.csv` then run:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
python build_pages.py # builds html out of csv
|
make events
|
||||||
python image_poster.py # generates images for events
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## TODO:
|
||||||
|
|
||||||
|
- [x] create page builder
|
||||||
|
- [x] rename `prep.py` to more informative name (`build_events.py`)
|
||||||
|
- [x] create xmpp bot that connects to events section.
|
||||||
|
- [ ] create blogging system
|
||||||
|
- [ ] webring system
|
||||||
|
- [x] make page
|
||||||
|
- [ ] populate page
|
||||||
|
- [x] make english version
|
||||||
|
- double check spelling and wording
|
||||||
|
- [x] add account and donations page and style them with the site style
|
||||||
|
|
||||||
|
|
||||||
## TODO:
|
## TODO:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user