https://github.com/pottekkat/awesome-readme
A template for writing a useful README.
https://github.com/pottekkat/awesome-readme
List: awesome-readme
document documentation documentation-tool open-source opensource readme readme-badges readme-md readme-template templates
Last synced: 5 months ago
JSON representation
A template for writing a useful README.
- Host: GitHub
- URL: https://github.com/pottekkat/awesome-readme
- Owner: pottekkat
- License: mit
- Created: 2020-07-12T18:05:10.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T12:24:23.000Z (about 3 years ago)
- Last Synced: 2025-10-19T19:59:45.597Z (8 months ago)
- Topics: document, documentation, documentation-tool, open-source, opensource, readme, readme-badges, readme-md, readme-template, templates
- Homepage: https://navendu.me/posts/how-to-write-an-awesome-readme/
- Size: 225 KB
- Stars: 327
- Watchers: 2
- Forks: 563
- Open Issues: 0
-
Metadata Files:
- Readme: README-template.md
- License: LICENSE
Awesome Lists containing this project
- awesome-writing - ottekkat/awesome-readme
README
# Project Title
# Quickstart/Demo
# Table of Contents
- [Project Title](#project-title)
- [Quickstart/Demo](#quickstartdemo)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Development](#development)
- [Contribute](#contribute)
- [License](#license)
# Installation
[(Back to top)](#table-of-contents)
# Usage
[(Back to top)](#table-of-contents)
# Development
[(Back to top)](#table-of-contents)
# Contribute
[(Back to top)](#table-of-contents)
# License
[(Back to top)](#table-of-contents)