Awesome Open Source
Awesome Open Source

// Header Design 1

Project Name

A one line description of the project.

Check It Out! | Read the Docs

// Header Design 2

Project Name

One line description of the project.

// Repo badges

Awesome Travis Build Status Appveyor Build Status Join the chat at https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME} GitHub forks GitHub stars GitHub tag GitHub release

// Project Logo

logo

// or ASCII Art

  _____                       _                        _ 
 |  __ \                     | |                      | |
 | |__) |   ___    __ _    __| |    _ __ ___     ___  | |
 |  _  /   / _ \  / _` |  / _` |   | '_ ` _ \   / _ \ | |
 | | \ \  |  __/ | (_| | | (_| |   | | | | | | |  __/ |_|
 |_|  \_\  \___|  \__,_|  \__,_|   |_| |_| |_|  \___| (_)
                                                         
                                                         

// Project Video

vido_thumbnail

// Body

Table of Contents

Prerequisites

Mention what things one needs to install the software and how to install them.

Add commands and links required.

Installation

Operating System:

> commands to install the project

Another OS:

$ 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.

Contributing

All patches welcome! Please read CONTRIBUTING.md for further details.

License

LICENSE NAME - see the LICENSE file for more details.

// or

License

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

    <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

    [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) [![Travis Build Status](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}.png?branch=master)](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/%7B%7Bstatus_id%7D%7D)](https://ci.appveyor.com/project/%7B%7Busername%7D%7D/%7B%7Bproject_name%7D%7D) [![Join the chat at https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME}](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub forks](https://img.shields.io/github/forks/satwikkansal/readme_styles.svg?style=social&label=Fork)](https://github.com/{USERNAME}/{REPO-NAME}) [![GitHub stars](https://img.shields.io/github/stars/{USERNAME}/{REPO-NAME}.svg?style=social&label=Star)](https://github.com/readme_styles) [![GitHub tag](https://img.shields.io/github/tag/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})
    [![GitHub release](https://img.shields.io/github/release/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})


    // Project Logo

    ![logo](PROJECT_LOGO_URL)

    // or ASCII Art

    ```
      _____                       _                        _ 
     |  __ \                     | |                      | |
     | |__) |   ___    __ _    __| |    _ __ ___     ___  | |
     |  _  /   / _ \  / _` |  / _` |   | '_ ` _ \   / _ \ | |
     | | \ \  |  __/ | (_| | | (_| |   | | | | | | |  __/ |_|
     |_|  \_\  \___|  \__,_|  \__,_|   |_| |_| |_|  \___| (_)


     ```

    // Project Video

    [![vido_thumbnail](https://c1.staticflickr.com/3/2154/2054140257_58e87296b6.jpg)](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

    [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

    ## Acknowledgements

    - Inspiration
    - People who helped
    - References to code reused

reStructuredText

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

    [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/sindresorhus/awesome) [![Travis Build Status](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}.png?branch=master)](https://travis-ci.org/{ORG-or-USERNAME}/{REPO-NAME}) [![Appveyor Build Status](https://ci.appveyor.com/api/projects/status/%7B%7Bstatus_id%7D%7D)](https://ci.appveyor.com/project/%7B%7Busername%7D%7D/%7B%7Bproject_name%7D%7D) [![Join the chat at https://gitter.im/{ORG-or-USERNAME}/{REPO-NAME}](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dwyl/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GitHub forks](https://img.shields.io/github/forks/satwikkansal/readme_styles.svg?style=social&label=Fork)](https://github.com/{USERNAME}/{REPO-NAME}) [![GitHub stars](https://img.shields.io/github/stars/{USERNAME}/{REPO-NAME}.svg?style=social&label=Star)](https://github.com/readme_styles) [![GitHub tag](https://img.shields.io/github/tag/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})
    [![GitHub release](https://img.shields.io/github/release/{USERNAME}/{REPO-NAME}.svg)](https://github.com/{USERNAME}/{REPO-NAME})


    // Project Logo

    ![logo](PROJECT_LOGO_URL)

    // or ASCII Art

    ```
      _____                       _                        _ 
     |  __ \                     | |                      | |
     | |__) |   ___    __ _    __| |    _ __ ___     ___  | |
     |  _  /   / _ \  / _` |  / _` |   | '_ ` _ \   / _ \ | |
     | | \ \  |  __/ | (_| | | (_| |   | | | | | | |  __/ |_|
     |_|  \_\  \___|  \__,_|  \__,_|   |_| |_| |_|  \___| (_)


     ```

    // Project Video

    [![vido_thumbnail](https://c1.staticflickr.com/3/2154/2054140257_58e87296b6.jpg)](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

    [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

    ## Acknowledgements

    - Inspiration
    - People who helped
    - References to code reused

Some Useful links


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
markdown (850
readme (62
logo (37
restructuredtext (26
badges (23
readme-template (22

Find Open Source By Browsing 7,000 Topics Across 59 Categories