jrmiller82
/
pathfinder-2-sqlite-MIRROR
mirror of https://gitlab.com/jrmiller82/pathfinder-2-sqlite.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Docker instructions to README

merge-requests/54/head
David Corne 2020-07-16 11:00:37 +01:00
parent f626023e3f
commit 518d22ba4d
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -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! ## 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. You'll need a working python3 installation and the module `pyyaml` installed.