jramboz / tintalle

Python/Qt-based application for managing OpenCore-based lightsabers
5 stars 1 forks source link

Add app documentation #4

Open jramboz opened 4 months ago

jramboz commented 4 months ago

Really needs full docs, but this seems to be the most important.

jramboz commented 3 days ago

After some research, I think I'm going to use Material for MkDocs to create the help files, and then just display them inside a web browser window. The native Qt help format requires the help file viewer to be installed natively on the host machine, and it doesn't seem like you can package it portably. So going with Markdown -> HTML seems to be the most portable and quickest to implement.

Now I just have to write them 😅