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.
If for some reason you want to build the documentation yourself, you can do so by following these steps:
-
Clone the repository:
-
Install the required dependencies:
pip install -r requirements.txt
-
Build the documentation:
make html
-
Open the documentation found at
build/html/index.html
with your browser.
The code itself is licensed under the MIT license.