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.

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

Integrate README with wiki page #1374

Open
mhalano opened this issue Feb 21, 2025 · 0 comments
Open

Integrate README with wiki page #1374

mhalano opened this issue Feb 21, 2025 · 0 comments

Comments

@mhalano
Copy link

mhalano commented Feb 21, 2025

TL;DR: Put all the vital information for install and use in the README instead of split between README and wiki. Put the advanced topics and longer explanations in the wiki.

Maybe can be a good idea to put the wiki page together in the README, so the README becomes a one-stop page to use the application. My main concern is related how to use the tool, like the default shortcut, that, I think, should be part of the README. Perhaps details about plugins, and more advanced features could be mentioned in the wiki with a link in the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant