Development

Running tests

The best way of making some changes or adding new functionality is to write tests first.

I use Qbs¹ as the build system because I like it the most. Please, read the documentation to learn how to set it up.

To run the tests, simply execute the command:

qbs build

Writing documentation

For this documentation, I use Material for MkDocs. You'll need a working Python interpreter to use it.

Assuming that you have it, first install the MkDocs:

macOS / LinuxWindows

pip3 install mkdocs-material

pip install mkdocs-material

Then, to run the documentation site locally, you can use:

mkdocs serve

For the rest of features, check their documentation.

---

1. It was also developed by Qt company in the past ↩