From 3e55c1dc8d6bdc2883a3fd5217ac85b2a1e6db71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?V=C3=AD=C3=B0ir=20Valberg=20Gu=C3=B0mundsson?= Date: Sun, 5 Nov 2017 17:48:21 +0100 Subject: [PATCH] Update readme. --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index aed1c041..7fb505eb 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,6 @@ This will create everything. You can now start the project running: ### Manual way - - #### Clone the repo Clone with --recursive to include submodules: @@ -49,13 +47,13 @@ Install system dependencies (method depends on OS): - Debian: ? - FreeBSD: x11-fonts/webfonts -### Python packages +#### Python packages Install pip packages: ``` (venv) $ pip install -r src/requirements.txt ``` -### Configuration file +#### Configuration file Copy environment settings file and change settings as needed: ``` (venv) $ cp src/bornhack/environment_settings.py.dist src/bornhack/environment_settings.py @@ -64,7 +62,7 @@ Copy environment settings file and change settings as needed: Edit the configuration file, replacing all the ``{{ placeholder }}`` patterns (intended for Ansible). -### Database +#### Database Is this a new installation? Initialize the database: ``` (venv) $ src/manage.py migrate @@ -75,7 +73,7 @@ Is this for local development? Bootstrap the database with dummy data and users: (venv) $ src/manage.py bootstrap-devsite ``` -### Deploy camps+program test data +#### Deploy camps+program test data Run this command to create a bunch of nice test data: @@ -84,7 +82,7 @@ Run this command to create a bunch of nice test data: ``` -### Done +#### Done Is this for local development? Start the Django devserver: ``` (venv) $ src/manage.py runserver