From b261650a3e3e98f1a25ac38a8d57d7b008fa2c93 Mon Sep 17 00:00:00 2001 From: Amandus Butzer Date: Wed, 20 Mar 2024 13:31:51 +0100 Subject: [PATCH] docs: adjust text & remove code whitespace --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ea82537..8bbad5e 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,9 @@ this is a tool for migrating from ors-config.json to ors-config.yml. -As with Release 8 a lot of config options have been restructured, this tool should help people -to migrate their configs from JSON to YAML format without hassle, and inform about changes made. +As with Release 8 a lot of config options have been restructured, this tool should help with +migrating configs from JSON to YAML format, inform about changes made and point out action steps +that need to be done manually. ## Usage @@ -14,8 +15,8 @@ as the current directory is mounted into the container as a volume: docker run --rm -v ${PWD}:/app heigit/ors-config-migration ``` -Please examine the container logs (should print to stdout) to see if there are any warnings or -errors concerning the migration. +Please examine the container logs carefully (should print to stdout) to see if there are any +warnings or errors concerning the migration and fix issues as needed. The migrated `ors-config.yml` will be written to the current working directory. @@ -28,13 +29,10 @@ Clone the repository and run the following commands in the repo-root directory: ```shell # create virtual python environment python3 -m venv .venv - # activate venv source .venv/bin/activate - # install requirements python3 -m pip install -r requirements.txt - # run migration script python3 migrate.py [] ```