Add a very basic README

This commit is contained in:
Adam Goldsmith 2023-04-22 22:06:59 -04:00
parent 45d287be7b
commit d490859356
1 changed files with 6 additions and 0 deletions

6
README.md Normal file
View File

@ -0,0 +1,6 @@
## Usage
1. Install [docker](https://www.docker.com/) and `docker compose`
2. Probably edit `parameters.yml`, but the defaults are fine for local testing
3. Optionally edit `setup.sh` to change where [arkhamdb-json-data](https://github.com/ad1217/arkhamdb-json-data) is pulled from
4. Run `setup.sh`