From 226a9c4a38b0a1b1b07e47067429ef08fd26316e Mon Sep 17 00:00:00 2001 From: Nick Hahn Date: Thu, 15 Sep 2022 18:36:16 +0200 Subject: [PATCH] Cleaned up readme --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 319aef6..7215df9 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,20 @@ Simple script to migrate content from one Hedgedoc instance to another. -## Setup +## Cypress + Follow the guide over [here](https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites). You also require NodeJS. Run `npm ci` to install the required packages. +### Execution + +To start cypress, simply execute `npx cypress open`. Then click `E2E Testing` and run using electron. This step could be automated using the `cypress` [API](https://docs.cypress.io/guides/guides/module-api). + + +## Python + Create new python venv: ``` python -m venv venv @@ -21,12 +29,10 @@ source venv/bin/activate Install the requirements ``` -pip -r requirements.txt +pip install -r requirements.txt ``` -## Execution - -To start cypress, simply execute `npx cypress open`. Then click `E2E Testing` and run using electron. This step could be automated using the `cypress` [API](https://docs.cypress.io/guides/guides/module-api). +### Execution Start the extractor ``` @@ -38,7 +44,7 @@ For example: python hedgedoc-image.py https://md.margau.net/dbk-meta pad.hacknang.de ``` -## Produced files +### Produced files The python scripts produces a `pads.json` which contains the mapping from `old_url` to `new_url`. All images land in `images/uploads`. Only images hosted on the `old_pads` URL are saved