16 lines
435 B
Markdown
16 lines
435 B
Markdown
|
# WiFi Tally Documentation
|
||
|
|
|
||
|
|
The files in [docs](docs/) create the [documentation on the project](https://wifi-tally.github.io/).
|
||
|
|
|
||
|
|
## Development
|
||
|
|
|
||
|
|
[Mkdocs](https://www.mkdocs.org/) is used to create the static documentation. To run it
|
||
|
|
locally:
|
||
|
|
|
||
|
|
````bash
|
||
|
|
pip install mkdocs mkdocs-material pygments mkdocs-macros-plugin --user
|
||
|
|
|
||
|
|
mkdocs serve
|
||
|
|
````
|
||
|
|
|
||
|
|
Point your browser to http://127.0.0.1:8000 to see the live preview of the documentation.
|