diff --git a/.gitignore b/.gitignore index d91f8cb..9a5a045 100644 --- a/.gitignore +++ b/.gitignore @@ -160,3 +160,5 @@ cython_debug/ #.idea/ .idea/ .env/ +docs-venv/ +site/ diff --git a/README.md b/README.md index 2eb6a47..51cbcd7 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,22 @@ ## Installation -Create a new python virtualenv +- Create a new python virtualenv `python3 -m venv docs-venv` -Activate the virtualenv, then +- Activate the virtualenv, then -`pip install mkdocs-material` or `pip install mkdocs-material=="9.*" ` +`pip install mkdocs-material` or `pip install mkdocs-material=="9.*"` -Or use the requirements.txt in the root of the project +- Or use the requirements.txt in the root of the project -`pip install -r requirements.txt` \ No newline at end of file +`pip install -r requirements.txt` + +- Previewing as you write + +`mkdocs serve` + +- Building your site + +`mkdocs build` \ No newline at end of file diff --git a/docs/google5e9a7c9479924ed2.html b/docs/google5e9a7c9479924ed2.html new file mode 100644 index 0000000..d6304cd --- /dev/null +++ b/docs/google5e9a7c9479924ed2.html @@ -0,0 +1 @@ +google-site-verification: google5e9a7c9479924ed2.html \ No newline at end of file