GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → dguo → Make A Readme

dguo / Make A Readme

Licence: mit
📄 Because nobody can read your mind (yet)

Labels

htmlreadmeguidelines

Projects that are alternatives of or similar to Make A Readme

Zalando Howto Open Source
Open Source guidance from Zalando, Europe's largest online fashion platform
Stars: ✭ 767 (+80.05%)
Mutual labels:  readme, guidelines
The Documentation Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
Stars: ✭ 4,306 (+910.8%)
Mutual labels:  readme, guidelines
lean-bem
A leaner, cleaner & prettier adaptation of BEM
Stars: ✭ 12 (-97.18%)
Mutual labels:  guidelines
Waka Readme
Wakatime Weekly Metrics on your Profile Readme.
Stars: ✭ 386 (-9.39%)
Mutual labels:  readme
Frankenstein
Correct README Redirects
Stars: ✭ 305 (-28.4%)
Mutual labels:  readme
CSharpNamingGuidelines
C#命名规范中文版/C#编码规范中文版
Stars: ✭ 30 (-92.96%)
Mutual labels:  guidelines
Ios Handbook
Guidelines and best practices for excellent iOS apps
Stars: ✭ 337 (-20.89%)
Mutual labels:  guidelines
actions-readme-feed
Display RSS feed in your GitHub Profile README
Stars: ✭ 26 (-93.9%)
Mutual labels:  readme
Github Profile Readme Generator
🚀 Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.
Stars: ✭ 7,812 (+1733.8%)
Mutual labels:  readme
Laraveltherightway.github.io
Laravel Best Practices (previously Laravel The Right Way)
Stars: ✭ 294 (-30.99%)
Mutual labels:  guidelines
Github Markdown Toc.go
Easy TOC creation for GitHub README.md (in go)
Stars: ✭ 387 (-9.15%)
Mutual labels:  readme
Readme Template
📜 Modelos readme para qualquer pessoa copiar e usar em seu GitHub.
Stars: ✭ 287 (-32.63%)
Mutual labels:  readme
repo-standards
A starter kit for setting up a new repo, including a checklist of what to include in your README and templates for other recommended files
Stars: ✭ 26 (-93.9%)
Mutual labels:  readme
Github Activity Readme
Updates README with the recent GitHub activity of a user
Stars: ✭ 354 (-16.9%)
Mutual labels:  readme
Coding-Standards
Coding Guidelines for C#
Stars: ✭ 125 (-70.66%)
Mutual labels:  guidelines
Standard Readme
A standard style for README files
Stars: ✭ 4,412 (+935.68%)
Mutual labels:  readme
teteusAraujo
Meu readme do meu perfil com informações sobre mim.
Stars: ✭ 123 (-71.13%)
Mutual labels:  readme
Format Readme
Формат файла README
Stars: ✭ 270 (-36.62%)
Mutual labels:  readme
Api Guidelines
Microsoft REST API Guidelines
Stars: ✭ 17,897 (+4101.17%)
Mutual labels:  guidelines
Awesome Readme Templates
A collection of awesome readme templates to display on your github profile.
Stars: ✭ 423 (-0.7%)
Mutual labels:  readme
View All Similar Projects ➔

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. The website is simple enough to not require a build process. Just open public/index.html in a browser.

If you want live reloading and have Node installed, run $ yarn install && yarn start. If you have Python and Docker installed, you can run $ ./dev start instead.

License

MIT

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].