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

Documentation #4

Open
Anzo52 opened this issue Mar 26, 2022 · 7 comments
Open

Documentation #4

Anzo52 opened this issue Mar 26, 2022 · 7 comments
Assignees
@mikeysan
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Anzo52
Copy link
Owner

Anzo52 commented Mar 26, 2022

Improve documentation
@Anzo52 Anzo52 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 26, 2022
@mikeysan
Copy link

Hey,

I don't know Java but I could help improve the documentation a bit. Please assign it to me if that's okay.

Regards,
Mikey

@mikeysan
Copy link

Actually, to do any sort of justice to the documentation we need more information; screenshots, how-to run, etc.

@Anzo52
Copy link
Owner Author

Anzo52 commented Apr 11, 2022

Agreed. I added a bit more info to the readme, which should hopefully help a bit. I'm trying to improve my knowledge of best practices for architecture and documentation, frankly I'm severely lacking in that area.

@Anzo52
Copy link
Owner Author

Anzo52 commented Apr 11, 2022

I don't know Java but I could help improve the documentation a bit.

Just take away the type declarations and curly-brackets and it's basically python. ;-)

@Anzo52
Copy link
Owner Author

Anzo52 commented Jun 20, 2022

@mikeysan If you're still able to contribute, go ahead and start a fork and link this issue in the PR. I'll hopefully have issue templates up soon. Thanks!

@mikeysan
Copy link

While I am willing, I am unable to at this time. :(

@Anzo52
Copy link
Owner Author

Anzo52 commented Sep 12, 2022

Understandable. Would you like me to un-assign it?

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

@mikeysan mikeysan

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mikeysan @Anzo52