Browse Source

Try to improve README

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

49
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.
Loading…
Cancel
Save