Make a README
FreeThe essential guide to writing a great README
FreeFree tier
About Make a README
Make a README is a comprehensive guide that explains what a README is, why it's important, who should create one, when to create it, where to place it, and how to write it using Markdown. It also provides an editable template with common sections like installation, usage, contributing, and license, plus suggestions for additional sections such as name, description, badges, and more. The site serves as a reference for anyone looking to create a clear and effective README for their open source or personal projects.
Key Features
Explanation of what, why, who, when, where, and how of READMEs
Editable Markdown template with common project sections
Suggestions for additional README sections such as name, description, badges, and more
Guidance on Markdown formatting and tools for editing
Pros & Cons
Pros
- Free and open source
- Comprehensive yet concise guide
- Includes editable template for instant use
- Covers all essential aspects of README creation
- Suitable for beginners and experienced developers alike
Cons
- Not an interactive tool; requires manual editing
- Limited to Markdown format
- No integration with project repositories
- Does not provide automatic generation based on project details
Best For
Creating a README for an open source projectLearning best practices for documentationQuickly generating a README using the provided templateTeaching others how to write effective READMEs
FAQ
What is a README?
A README is a text file that introduces and explains a project. It contains information commonly required to understand what the project is about.
Why should I make a README?
It's an easy way to answer questions that your audience will likely have regarding how to install and use your project and also how to collaborate with you.
Who should make a README?
Anyone who is working on a programming project, especially if you want others to use it or contribute.
When should I make a README?
Definitely before you show a project to other people or make it public. You might want to get into the habit of making it the first file you create in a new project.
Where should I put the README?
In the top level directory of the project. Code hosting services like GitHub, Bitbucket, and GitLab will look for your README and display it.
How should I make a README?
While READMEs can be written in any text file format, the most common is Markdown. You can use any text editor with Markdown preview or a dedicated Markdown editor. The site provides an editable template.