varia/manymanymany-varia-websites
14
1
Fork 0
forked from varia/varia.website
Code Issues 1 Pull Requests Releases Wiki Activity

Improve the README structure

Browse Source
This commit is contained in:
Luke Murphy 2020-03-11 18:27:44 +01:00
parent be5ec73c8b
commit ebccea5984
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 7 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -7,6 +7,8 @@ Many websites for the many.
## Make your own ## Make your own
```bash ```bash
$ git clone https://git.vvvvvvaria.org/varia/manymanymany-varia-websites
$ cd manymanymany-varia-websites
$ cp -R old myexperiment $ cp -R old myexperiment
``` ```
@ -18,44 +20,26 @@ If you want to build the site locally, follow the steps below.
## Build the site locally ## Build the site locally
### Get a local copy Choose a site.
```bash ```bash
$ git clone https://git.vvvvvvaria.org/varia/manymanymany-varia-websites $ cd 3colplus
``` ```
### Choose a version Create a virtual environment and activate it.
```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 ```bash
$ python3 -m venv .venv $ python3 -m venv .venv
$ source .venv/bin/activate $ source .venv/bin/activate
``` ```
Then install the requirements: Install the requirements.
```bash ```bash
$ pip install -r requirements.txt $ pip install -r requirements.txt
``` ```
### Generating the site Generate the content and run the server.
Generate the content and run the server:
```bash ```bash
$ make devserver $ make devserver