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

More user friendly README.md #31

Closed
shapkarin opened this issue Dec 23, 2020 · 8 comments
Closed

More user friendly README.md #31

shapkarin opened this issue Dec 23, 2020 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@shapkarin
Copy link
Owner

Make the introduction with basic explanation as much simple and understandable as it can be.
Leave all the rest as docs section.

@shapkarin shapkarin added enhancement New feature or request documentation Improvements or additions to documentation and removed enhancement New feature or request labels Dec 23, 2020
@Styrle
Copy link
Contributor

Styrle commented Dec 25, 2020

Hi there, I would love to be assigned to this. I have previously created readme's similar to this and would love to take it on.

@shapkarin
Copy link
Owner Author

shapkarin commented Dec 25, 2020 via email

@shapkarin
Copy link
Owner Author

@Styrle also related issue #29

@shapkarin
Copy link
Owner Author

@Styrle how it's going? maybe you can upload some version and we can make it together?

@Styrle
Copy link
Contributor

Styrle commented Jan 25, 2021

Ok I can do that

@Styrle
Copy link
Contributor

Styrle commented Feb 2, 2021

You should be able to pull it now

@shapkarin
Copy link
Owner Author

Closed with #36 #37 #38

@shapkarin
Copy link
Owner Author

shapkarin commented Feb 15, 2021

@Styrle thanks for your help. Readme got much better typographyc.

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

No branches or pull requests

2 participants