From 4932e07b2864961005f7a2638bd02ba2ed282357 Mon Sep 17 00:00:00 2001 From: Luke Murphy Date: Wed, 11 Mar 2020 15:29:30 +0100 Subject: [PATCH] Try to improve README --- README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 48 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a960822..5173c2a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,54 @@ # manymanymany-varia-websites -## Get Started +> https://many.vvvvvvaria.org + +## Build the site locally + +### Get a local copy ```bash $ git clone https://git.vvvvvvaria.org/varia/manymanymany-varia-websites ``` + +### Choose a version + +```bash +$ cd manymanymany-varia-websites/3-column-plus +``` + +### System requirements + +Install the system requirements (on Debian based systems): + +```bash +$ sudo apt install -y python3 python3-dev python3-venv +``` + +### Python requirements + +Then create a virtual environment and activate it: + +```bash +$ python3 -m venv .venv +$ source .venv/bin/activate +``` + +Then install the requirements: + +```bash +$ pip install -r requirements.txt +``` + +### Generating the site + +Generate the content and run the server: + +```bash +$ make devserver +``` + +Then the site is available at the following URL: + +> http://localhost:8000 + +You can use `make help` for the other commands.