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

readme improvements #438

Open

pkp124 opened this issue Jan 7, 2025 · 1 comment

Assignees

Labels

pkp124 commented Jan 7, 2025

Hello,

Suggestion to improve readme of this project, to help newbies like me. Things like

Prerequisities
Installation
Simple usage
Advanced options descriptions

These would be very helpful :)

Thanks

Collaborator

zeddii commented Jan 10, 2025

Some of this is covered, but I'm currently updating the READMEs to document some new options and the release schedule/process.

So I'll keep these in mind and make sure they are either reorganized to make them more visible or add the missing content.

zeddii self-assigned this

zeddii changed the title ~~readme imporvements~~ readme improvements

zeddii added the documentation label

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