diff --git a/README.md b/README.md index de7c1aa..1a0c866 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## `docker-compose` configuration for [ThreeTwo](https://github.com/rishighan/threetwo) +## docker-compose configuration for [ThreeTwo](https://github.com/rishighan/threetwo) This repo contains the `docker-compose` files necessary to run: @@ -11,7 +11,14 @@ This repo contains the `docker-compose` files necessary to run: #### Docker and docker-compose -### `comics` and `userdata` folders +You need both `docker` and `docker-compose` installed on your OS. Currently, `Docker version 20.10.10, build b485636` and `docker-compose version 1.29.2, build 5becea4c` have tested well on `Debian 4.19.208-1` + +#### `comics` and `userdata` folders + +You need 2 folders: + +1. `comics` will contain your... comics +2. `userdata` will be used by the app to create app-specific files #### ComicVine @@ -26,3 +33,6 @@ You can get one [here.](https://comicvine.gamespot.com/api/) Metadata scraping w 3. After successfully connecting, you need to select your default hubs for search under `Settings > Acquisition > AirDC++ > Hubs` ## Building the stack + +1. Clone this repo +2. Edit the `docker-compose.env` file