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

Readme! #29

Open
frannyfra opened this issue Nov 8, 2019 · 0 comments
Open

Readme! #29

frannyfra opened this issue Nov 8, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@frannyfra
Copy link

You have got a nice and short readme.

You could make it a bit more descriptive and maybe using some bullet points to make it more readable and easy to follow.

Documentation is an important part of a project, needs to communicate the whole process to other people.

It would be helpful (it was for my personal experience) to create a HackMd in advance and just drop everything you need in there, later the only thing you have to do is clean it up and remove the irrelevant bits.

Will help you save time and keep a good truck of your project learning.

😄
@frannyfra frannyfra added the documentation Improvements or additions to documentation label Nov 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@frannyfra