Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add app documentation #4

Open
jramboz opened this issue May 11, 2024 · 1 comment
Open

Add app documentation #4

jramboz opened this issue May 11, 2024 · 1 comment
Assignees
@jramboz
Labels
documentation Improvements or additions to documentation

Comments

@jramboz
Copy link
Owner

jramboz commented May 11, 2024

Really needs full docs, but this seems to be the most important.
@jramboz jramboz added the documentation Improvements or additions to documentation label May 11, 2024
@jramboz jramboz self-assigned this May 11, 2024
@jramboz jramboz changed the title Add sound file documentation Add app documentation Sep 16, 2024
@jramboz
Copy link
Owner Author

jramboz commented Sep 16, 2024

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 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jramboz jramboz

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jramboz