Browse Source

Improve the README structure

master
decentral1se 1 year ago
parent
commit
ebccea5984
No known key found for this signature in database GPG Key ID: 5E2EF5A63E3718CC
  1. 30
      README.md

30
README.md

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

Loading…
Cancel
Save