https://github.com/satwikkansal/readme_styles
Minimal README.rst and README.md template for Github projects.
https://github.com/satwikkansal/readme_styles
badges logo markdown readme readme-template repositories restructuredtext
Last synced: 7 months ago
JSON representation
Minimal README.rst and README.md template for Github projects.
- Host: GitHub
- URL: https://github.com/satwikkansal/readme_styles
- Owner: satwikkansal
- License: unlicense
- Created: 2017-08-11T16:46:49.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-11T19:18:19.000Z (about 8 years ago)
- Last Synced: 2025-03-15T06:16:32.805Z (7 months ago)
- Topics: badges, logo, markdown, readme, readme-template, repositories, restructuredtext
- Homepage:
- Size: 33.2 KB
- Stars: 66
- Watchers: 2
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
// Header Design 1
Project Name
A one line description of the project.
// Header Design 2
# Project Name
> One line description of the project.
// Repo badges
[](https://github.com/sindresorhus/awesome) [](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) [](https://ci.appveyor.com/project/%7B%7Busername%7D%7D/%7B%7Bproject_name%7D%7D) [](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://github.com/satwikkansal/readme_styles) [](https://github.com/readme_styles) [](https://github.com/satwikkansal/readme_styles)
[](https://github.com/satwikkansal/readme_styles)
// Project Logo
// or ASCII Art
```
_____ _ _
| __ \ | | | |
| |__) | ___ __ _ __| | _ __ ___ ___ | |
| _ / / _ \ / _` | / _` | | '_ ` _ \ / _ \ | |
| | \ \ | __/ | (_| | | (_| | | | | | | | | __/ |_|
|_| \_\ \___| \__,_| \__,_| |_| |_| |_| \___| (_)
```
// Project Video
[](https://www.youtube.com/watch?v=SjORe3_2bQc)
// Body
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Acknowldegements](#acknowledgements)
- **Raw templates:** [Markdown](#markdown) and [reStructuredText](#restructuredtext)
- [Some Useful Links](#some-useful-links)
## Prerequisites
Mention what things one needs to install the software and how to install them.
```
Add commands and links required.
```
## Installation
Operating System:
```sh
> commands to install the project
```
Another OS:
```sh
$ commands to install the project
```
## Usage
Basic usage instructions to help people to just get started using your project.
For more examples and usage, please refer to the [Wiki](https://github.com/yourname/yourproject/wiki).
## Contributing
All patches welcome! Please read [CONTRIBUTING.md](https://github.com/satwikkansal/readme_styles/blob/master/CONTRIBUTING.md) for further details.
## License
LICENSE NAME - see the [LICENSE](https://github.com/satwikkansal/readme_styles/blob/master/LICENSE) file for more details.
// or
[](https://opensource.org/licenses/Apache-2.0)
## Acknowledgements
- Inspiration
- People who helped
- References to code reused
---
That's all folks!
Raw version in the Markdown and reStructuredText format are available below
#### Markdown
```
// Header Design 1
Project Name
A one line description of the project.
// Header Design 2
# Project Name
> One line description of the project.
// Repo badges
[](https://github.com/sindresorhus/awesome) [](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) [](https://ci.appveyor.com/project/%7B%7Busername%7D%7D/%7B%7Bproject_name%7D%7D) [](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://github.com/{USERNAME}/{REPO-NAME}) [](https://github.com/readme_styles) [](https://github.com/{USERNAME}/{REPO-NAME})
[](https://github.com/{USERNAME}/{REPO-NAME})
// Project Logo
// or ASCII Art
```
_____ _ _
| __ \ | | | |
| |__) | ___ __ _ __| | _ __ ___ ___ | |
| _ / / _ \ / _` | / _` | | '_ ` _ \ / _ \ | |
| | \ \ | __/ | (_| | | (_| | | | | | | | | __/ |_|
|_| \_\ \___| \__,_| \__,_| |_| |_| |_| \___| (_)
```
// Project Video
[](PROJECT_VIDEO_URL)
// Body
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Acknowldegements](#acknowledgements)
## Prerequisites
Mention what things you need to install the software and how to install them.
```
Add commands and links required.
```
## Installation
Operating System:
```sh
> commands to install the project
```
Another OS:
```sh
$ commands to install the project
```
## Usage
Basic usage instructions to help people to just get started using your project.
For more examples and usage, please refer to the [Wiki](https://github.com/yourname/yourproject/wiki).
## Contributing
All patches welcome! Please read [CONTRIBUTING.md](https://github.com/{USERNAME}/{REPO-NAME}/blob/master/CONTRIBUTING.md) for furthers details.
## License
LICENSE NAME - see the [LICENSE](https://github.com/satwikkansal/readme_styles/blob/master/LICENSE) file for details
// or
[](https://opensource.org/licenses/Apache-2.0)
## Acknowledgements
- Inspiration
- People who helped
- References to code reused
```
#### reStructuredText
Converted from the above markdown using [pandoc](https://pandoc.org/try/):
```
::
// Header Design 1
Project Name
A one line description of the project.
// Header Design 2
# Project Name
> One line description of the project.
// Repo badges
[](https://github.com/sindresorhus/awesome) [](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) [](https://ci.appveyor.com/project/%7B%7Busername%7D%7D/%7B%7Bproject_name%7D%7D) [](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://github.com/{USERNAME}/{REPO-NAME}) [](https://github.com/readme_styles) [](https://github.com/{USERNAME}/{REPO-NAME})
[](https://github.com/{USERNAME}/{REPO-NAME})
// Project Logo
// or ASCII Art
```
_____ _ _
| __ \ | | | |
| |__) | ___ __ _ __| | _ __ ___ ___ | |
| _ / / _ \ / _` | / _` | | '_ ` _ \ / _ \ | |
| | \ \ | __/ | (_| | | (_| | | | | | | | | __/ |_|
|_| \_\ \___| \__,_| \__,_| |_| |_| |_| \___| (_)
```
// Project Video
[](PROJECT_VIDEO_URL)
// Body
## Table of Contents
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [Acknowldegements](#acknowledgements)
## Prerequisites
Mention what things you need to install the software and how to install them.
```
Add commands and links required.
```
## Installation
Operating System:
```sh
> commands to install the project
```
Another OS:
```sh
$ commands to install the project
```
## Usage
Basic usage instructions to help people to just get started using your project.
For more examples and usage, please refer to the [Wiki](https://github.com/yourname/yourproject/wiki).
## Contributing
All patches welcome! Please read [CONTRIBUTING.md](https://github.com/{USERNAME}/{REPO-NAME}/blob/master/CONTRIBUTING.md) for furthers details.
## License
LICENSE NAME - see the [LICENSE](https://github.com/satwikkansal/readme_styles/blob/master/LICENSE) file for details
// or
[](https://opensource.org/licenses/Apache-2.0)
## Acknowledgements
- Inspiration
- People who helped
- References to code reused
```
### Some Useful links
- **Repo Badges:** https://github.com/dwyl/repo-badges and https://github.com/bevacqua/awesome-badges
- **Create ASCII art from text:** http://patorjk.com/software/taag/
- **License Badges:** https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba