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

Write a proper usage guide to docs #3

Open
Diapolo10 opened this issue Apr 4, 2022 · 0 comments
Open

Write a proper usage guide to docs #3

Diapolo10 opened this issue Apr 4, 2022 · 0 comments
Assignees
@Diapolo10 @Usmo
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Diapolo10
Copy link
Owner

Right now, all of the "documentation" for the project is in the README.md file, but it should really be in docs. Today it became apparent that the quick guide for running the program is incomplete, and therefore a proper one should be written as documentation and linked to in the README.
@Diapolo10 Diapolo10 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 4, 2022
@Diapolo10 Diapolo10 self-assigned this Apr 4, 2022
@Diapolo10 Diapolo10 added the help wanted Extra attention is needed label Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Diapolo10 Diapolo10

@Usmo Usmo

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Diapolo10 @Usmo