MLH-Fellowship / 0.2.1-readme-dirs

A web application that generates helpful project structures for public GitHub repositories
https://project-structure-readme.netlify.app/
MIT License
1 stars 1 forks source link

Write a more helpful README #2

Closed nchaloult closed 4 years ago

nchaloult commented 4 years ago

Right now, our project's README is the default one generated for us by the create-react-app utility. I'm thinking that we should scrap our current README & brainstorm ideas for what relevant information we should include in a new README.

When I think about our new README's contents, the first things that come to my mind are:

This new README might be one of the last things that we work on during this hackathon, but I thought it was worthwhile to go ahead and create an issue about it now so that it stays on our minds.

nchaloult commented 4 years ago

@ralph-dev made significant progress on our README's contents. As a team, we need to review what he's written and decide if there is anything that isn't present that we should add.

ralph-dev commented 4 years ago

@mohammedsahl @nchaloult The only thing I can think of left is a GIF of the application!

ralph-dev commented 4 years ago

@mohammedsahl Can you upload the gif to the README