From 323da8e0df0185d5fc901bfb1628a05d9b6d86cf Mon Sep 17 00:00:00 2001 From: radex Date: Mon, 11 May 2020 17:28:29 +0200 Subject: [PATCH] improve readme for the newbs --- README.md | 9 +++++++++ docker-compose.yml | 5 +++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index 3d82986..0ce5f7a 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,15 @@ Please use Python3, for the love of `$deity`... ## Usage +### Quick start + +1. Open `docker-compose.yml` and make changes as comments indicate (TODO: Please someone make this not awful) +2. Run: + ```sh + docker-compose up --build + ``` + + ### Build & run ```sh diff --git a/docker-compose.yml b/docker-compose.yml index 598ac62..7dfc852 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -3,8 +3,12 @@ services: db: build: postgres-hstore restart: always + # NOTE: Comment out `volumes` for development volumes: - /var/spejstore-data:/var/lib/postgresql/data + # NOTE: Uncomment this awful thing for development + # environment: + # - POSTGRES_HOST_AUTH_METHOD=trust web: build: . @@ -19,4 +23,5 @@ services: env_file: - spejstore-dev.env + # NOTE: Comment out this for development - spejstore.env