From 77c5927822ab1c931d152303d557ce6be35ab891 Mon Sep 17 00:00:00 2001 From: Akitake Date: Tue, 4 Jun 2024 18:03:13 +0200 Subject: [PATCH 1/4] Update CONTRIBUTING with live preview --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index df012cc..d0b6c8b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,14 @@ We welcome contributions to TWO-TORIAL. To contribute, follow these steps: 4. Push to the Branch (`git push origin feature/LeBranch`) 5. Open a Pull Request +For quick local iteration, you can setup your own [mkdocs](https://www.mkdocs.org/user-guide/installation/) environment: + +1. Install the latest [Python](https://www.python.org/) and [pip](https://pip.readthedocs.io/en/stable/installing/) +2. Make sure pip is up-to-date by running `pip install --upgrade pip` +3. Change directory to the root of your forked project and run `python -m pip install -r requirements.txt` +4. From the same root directory run `python -m mkdocs serve`. You can now access your live preview at `http://127.0.0.1:8000/`. + +The live preview will update in real time as changes are found in your files. ## License From c71fd9142226291adae1504102f4ec83c65d9abf Mon Sep 17 00:00:00 2001 From: Akitake Date: Tue, 4 Jun 2024 18:03:41 +0200 Subject: [PATCH 2/4] Update wording --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0b6c8b..a20c375 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,9 @@ For quick local iteration, you can setup your own [mkdocs](https://www.mkdocs.or 1. Install the latest [Python](https://www.python.org/) and [pip](https://pip.readthedocs.io/en/stable/installing/) 2. Make sure pip is up-to-date by running `pip install --upgrade pip` 3. Change directory to the root of your forked project and run `python -m pip install -r requirements.txt` -4. From the same root directory run `python -m mkdocs serve`. You can now access your live preview at `http://127.0.0.1:8000/`. +4. From the same root directory run `python -m mkdocs serve` +You can now access your live preview at `http://127.0.0.1:8000/`. The live preview will update in real time as changes are found in your files. ## License From c3786dd98e125a436be8e7d9f806131dbddd375a Mon Sep 17 00:00:00 2001 From: Akitake Date: Tue, 4 Jun 2024 18:04:02 +0200 Subject: [PATCH 3/4] Fixed formatting --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a20c375..6f9e46e 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ For quick local iteration, you can setup your own [mkdocs](https://www.mkdocs.or 3. Change directory to the root of your forked project and run `python -m pip install -r requirements.txt` 4. From the same root directory run `python -m mkdocs serve` -You can now access your live preview at `http://127.0.0.1:8000/`. +You can now access your live preview at `http://127.0.0.1:8000/`. The live preview will update in real time as changes are found in your files. ## License From 2c58c24c6cfb274ccdb40819f4f9a4b7ea8e2daf Mon Sep 17 00:00:00 2001 From: Akitake Date: Tue, 4 Jun 2024 18:04:19 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f9e46e..dda7255 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ For quick local iteration, you can setup your own [mkdocs](https://www.mkdocs.or 3. Change directory to the root of your forked project and run `python -m pip install -r requirements.txt` 4. From the same root directory run `python -m mkdocs serve` -You can now access your live preview at `http://127.0.0.1:8000/`. +You can now access your live preview at `http://127.0.0.1:8000/` The live preview will update in real time as changes are found in your files. ## License