From d490859356e120385b3ddaee1c64ee2e1b5fb4cc Mon Sep 17 00:00:00 2001 From: Adam Goldsmith Date: Sat, 22 Apr 2023 22:06:59 -0400 Subject: [PATCH] Add a very basic README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..98ac7c8 --- /dev/null +++ b/README.md @@ -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`