Cool_Tools/two-torial
1
0
Fork 0
mirror of https://github.com/yxrei/two-torial.git synced 2024-11-23 23:20:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING with live preview

Browse Source
This commit is contained in:
Akitake 2024-06-04 18:03:13 +02:00 committed by GitHub
parent ade8f2e80e
commit 77c5927822
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -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