From 2bcf810adb27fe3db158da4a445fbcd8f0bfcff2 Mon Sep 17 00:00:00 2001 From: d-fens Date: Tue, 7 Jan 2025 16:20:55 +0000 Subject: [PATCH] Update README.md --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 834e07c..d133943 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,20 @@ ## How to use -The prerequise is that docker is installed and running correctly. +The prerequisite is that docker is installed and running correctly. + +### docker + +Create a folder, open a prompt in it, run the command: + +`docker run -v ./:/output ghcr.io/d-fens/tstomirror:main` + +### docker compose Download the [docker-compose.yml](https://raw.githubusercontent.com/d-fens/tstomirror/refs/heads/main/docker-compose.yml) file into an **empty** directory. -Run `docker compose run mirror` in a command promp in the same folder. +Run `docker compose run mirror` in a command prompt in the same folder. -Check the folder contains the output which is a folder called `static` that contains `oct2018-4-35-0-uam5h44a.tstodlc.eamobile.com` and a log file of the run called `debug.log`. If run from the same folder it will refresh the content. +Check the folder contains the folder `oct2018-4-35-0-uam5h44a.tstodlc.eamobile.com` and a log file of the run called `debug.log`. If run from the same folder it will refresh the content. -A number of older files will be missing from the output and have an WARNING message in the logs. +A number of older files will be missing from the output and have a WARNING message in the logs.