// Header Design 1
A one line description of the project.
// Header Design 2
One line description of the project.
// Repo badges
// Project Logo
// or ASCII Art
_____ _ _
| __ \ | | | |
| |__) | ___ __ _ __| | _ __ ___ ___ | |
| _ / / _ \ / _` | / _` | | '_ ` _ \ / _ \ | |
| | \ \ | __/ | (_| | | (_| | | | | | | | | __/ |_|
|_| \_\ \___| \__,_| \__,_| |_| |_| |_| \___| (_)
// Project Video
// Body
- Prerequisites
- Installation
- Usage
- Contributing
- Acknowldegements
- Raw templates: Markdown and reStructuredText
- Some Useful Links
Mention what things one needs to install the software and how to install them.
Add commands and links required.
Operating System:
> commands to install the projectAnother OS:
$ commands to install the projectBasic usage instructions to help people to just get started using your project.
For more examples and usage, please refer to the Wiki.
All patches welcome! Please read CONTRIBUTING.md for further details.
LICENSE NAME - see the LICENSE file for more details.
// or
- Inspiration
- People who helped
- References to code reused
Raw version in the Markdown and reStructuredText format are available below
// Header Design 1
<h1 align="center">Project Name</h1>
<p align="center">A one line description of the project.</p>
<p align="center"><a href="#site">Check It Out!</a> | <a href="#documentation">Read the Docs</a></p>
// 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
Converted from the above markdown using pandoc:
::
// Header Design 1
<h1 align="center">Project Name</h1>
<p align="center">A one line description of the project.</p>
<p align="center"><a href="#site">Check It Out!</a> | <a href="#documentation">Read the Docs</a></p>
// 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
- 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