From 518d22ba4dd5cd22e8b64a3e3be6f10e6541955f Mon Sep 17 00:00:00 2001 From: David Corne Date: Thu, 16 Jul 2020 11:00:37 +0100 Subject: [PATCH] Add Docker instructions to README --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 44ef649..c233e1f 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,25 @@ limitations on concurrent writes won't be an issue either. ## Stop yacking and tell me how to generate the database from the YAMl! -Ok! +Ok! There are two ways of doing this; using Docker containers, and manually +setting things up. If you just want to generate the database and use it, I'd +recommend Docker, if you want to actively develop this repo the manual setup +may be preferable. + +### Using Docker + +First you will need docker, you can set that up from [here](https://www.docker.com/get-started). + +The included Dockerfile is set up so that it will install the correct +dependencies and run the database generation script. Everyone's workflow will +differ, but this will get you a generated database: + +``` +docker build -t pathfinder-2-sqlite -f .\Dockerfile . +docker run -it pathfinder-2-sqlite +``` + +### Manual Setup You'll need a working python3 installation and the module `pyyaml` installed.