mirror of
https://github.com/nqrduck/NQRduckumentation.git
synced 2025-01-02 21:38:09 +00:00
29 lines
669 B
Markdown
29 lines
669 B
Markdown
# NQRduckumentation
|
|
|
|
Welcome to the NQRduckumentation - the central place for all documentation regarding the NQRduck software.
|
|
|
|
This is obviously only the README file. The actual documentation is built using Sphinx.
|
|
|
|
## Installation
|
|
|
|
If for some reason you want to build the documentation yourself, you can do so by following these steps:
|
|
|
|
1. Clone the repository:
|
|
|
|
2. Install the required dependencies:
|
|
|
|
```bash
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
3. Build the documentation:
|
|
|
|
```bash
|
|
make html
|
|
```
|
|
|
|
4. Open the documentation found at `build/html/index.html` with your browser.
|
|
|
|
## License
|
|
|
|
The code itself is licensed under the MIT license.
|