https://github.com/dguo/make-a-readme

:page_facing_up: Because nobody can read your mind (yet)
https://github.com/dguo/make-a-readme

guidelines readme readme-template

Last synced: about 2 months ago
JSON representation

:page_facing_up: Because nobody can read your mind (yet)

• Host: GitHub
• URL: https://github.com/dguo/make-a-readme
• Owner: dguo
• License: mit
• Created: 2017-08-14T02:17:23.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-07-13T12:53:10.000Z (11 months ago)
• Last Synced: 2024-11-08T15:46:56.748Z (7 months ago)
• Topics: guidelines, readme, readme-template
• Language: TypeScript
• Homepage: https://makeareadme.com
• Size: 2.83 MB
• Stars: 689
• Watchers: 16
• Forks: 105
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Make a README

[![Netlify Status](https://api.netlify.com/api/v1/badges/68992d1c-36d4-4a84-b177-00c1f64fbcb4/deploy-status)](https://app.netlify.com/sites/make-a-readme/deploys)

[![CI status](https://github.com/dguo/make-a-readme/workflows/CI/badge.svg)](https://github.com/dguo/make-a-readme/actions?query=branch%3Amain)

[Make a README](https://makeareadme.com) 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](https://chris.beams.io/posts/git-commit/) that

can matter more than we might think.

Make a README is inspired by [Keep a Changelog](http://keepachangelog.com/).

## Related Resources

- [Art of README](https://github.com/noffle/art-of-readme)

- [Awesome README](https://github.com/matiassingers/awesome-readme)

- [Standard Readme](https://github.com/RichardLitt/standard-readme)

## Roadmap

- Translate the website

- Create an interactive README generator ([#15](https://github.com/dguo/make-a-readme/issues/15))

- Link to great examples ([#14](https://github.com/dguo/make-a-readme/issues/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](https://github.com/dguo/make-a-readme/blob/main/LICENSE)