Skip to content

dguo/make-a-readme

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
dev
 
 
 
 
 
 
 
 
 
 

Make a README

Netlify Status CI status

Make a README explains what a README is, what the benefits are, and what makes for a good README. It also provides an editable template, with live Markdown rendering.

I hope people who are new to programming will find it useful, but even for more experienced programmers, I think it's worth evaluating once in a while if we are doing a good job when it comes to the small details that can matter more than we might think.

Make a README is inspired by Keep a Changelog.

Related Resources

Roadmap

  • Translate the website
  • Create an interactive README generator (#15)
  • Link to great examples (#14)
  • check and improve accessibility

Contributing

Please feel free to submit an issue or pull request. To develop, you'll need Node.js. Run yarn install && yarn dev.

License

MIT