updating README.txt
Some checks reported warnings
Publish to docs.datacontroller.io / Deploy docs (push) Has been cancelled

This commit is contained in:
Allan 2023-06-30 16:43:12 +01:00
parent e2a73d30f7
commit 617ff1dffb

View File

@ -1,16 +1,3 @@
1. brew install mkdocs
2. pip install mkdocs-material
3. pip install fontawesome_markdown
4. `npm install -g license-checker`
To build, navigate to the root of this repo and run:
mkdocs build --clean
mkdocs serve
To deploy, run the following:
`rsync -avz --exclude .git/ --del -e "ssh -p 722" ~/git/dcdocs/site/ macropeo@`
Deploy steps in build.sh
Note that the readme has been renamed to README.txt to prevent github pages from considering it to be the index by default!