nqrduck/NQRduckumentation
1
0
Fork 1
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
The documentation for the NQRduck program.
45 commits 2 branches 0 tags 9.3 MiB
Find a file
Kumi 846a9007be
All checks were successful
Build and Publish Sphinx Documentation / build (push) Successful in 6m25s
Details
Merge pull request 'fix: Build limedriver to avoid invalid instruction failure' (#1) from kumi/NQRduckumentation:main into main 
Reviewed-on: #1
2025-05-01 16:02:08 +00:00
.forgejo/workflows Merge pull request 'fix: Build limedriver to avoid invalid instruction failure' (#1) from kumi/NQRduckumentation:main into main 2025-05-01 16:02:08 +00:00
source Added development notes, updated README. 2024-06-26 21:39:48 +02:00
.gitignore Initial commit. 2024-05-03 15:11:25 +02:00
LICENCE Initial commit. 2024-05-03 15:11:25 +02:00
make.bat Initial commit. 2024-05-03 15:11:25 +02:00
Makefile Initial commit. 2024-05-03 15:11:25 +02:00
README.md Added development notes, updated README. 2024-06-26 21:39:48 +02:00
requirements.txt Update requirements.txt 2025-05-01 15:49:02 +00:00

README.md

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:

    pip install -r requirements.txt

  3. Build the documentation:

    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.