diff --git a/.gitignore b/.gitignore index 969fec1..66abceb 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,4 @@ site/ .selid-hooks/ .check-identity .obsidian -pyvenv.cfg -scripts/ -Lib/ -Include/ \ No newline at end of file +venv/ \ No newline at end of file diff --git a/README.md b/README.md index 307a468..52fd480 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,23 @@ We recommend previewing the site before submitting your PR. To preview the site ### Install python, dependencies and mkdocs +#### Windows + 1. Install [CPython](https://python.org) -1. Install [pipx](https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx) -1. `pipx install poetry` -1. `cd path/to/docs` -1. `poetry install --no-root` -1. `mkdocs serve` +2. Open a Terminal (cmd or powershell) in the docs folder +3. Run `.\setup.bat` + +#### Linux + +1. Install python3 +2. Create a python venv & activate it +3. `pip install -U poetry` +4. `poetry install --no-root` + + +### Run local development server + +To run a local development server now, just run `.\serve.bat` +or `mkdocs serve` if your directly within your venv + +You now have a development server running at [http://127.0.0.1:8000/](http://127.0.0.1:8000/) \ No newline at end of file diff --git a/scripts/run.ps1 b/scripts/run.ps1 deleted file mode 100644 index ac41338..0000000 --- a/scripts/run.ps1 +++ /dev/null @@ -1 +0,0 @@ -mkdocs serve \ No newline at end of file diff --git a/serve.bat b/serve.bat new file mode 100644 index 0000000..486f4b5 --- /dev/null +++ b/serve.bat @@ -0,0 +1,2 @@ +call scripts/activate +mkdocs serve \ No newline at end of file diff --git a/setup.bat b/setup.bat new file mode 100644 index 0000000..33469f9 --- /dev/null +++ b/setup.bat @@ -0,0 +1,4 @@ +python -m venv ./venv +call scripts/activate +pip install -U poetry +poetry install --no-root \ No newline at end of file