README

Getting Started

List steps to get my project started here.

Below here are examples to use in your README.md file.

Site Title

Any GitHub tags here.

Short Description here.

Demo: Link to demo

Table of contents

• Quick start
• Bugs and feature requests
• Documentation
• Contributing
• Community
• Versioning
• Creators
• Copyright and license

Quick start

Several quick start options are available:

• List here download 1
• Another download option here
• Again with another option here

Read me here at the getting started page - put in a link.

What's included

Within the download you'll find the following directories and files:

root/
├── css/
│   ├-- project.css.map
│   ├── project.css.map
│   ├── project.min.css
│   ├── project-theme.css
│   ├── project-theme.css.map
│   └── project-theme.min.css
├── js/
│   ├── project.js
│   └── project.min.js
└── fonts/
    ├── project.eot
    ├── project.svg
    ├── project.ttf
    ├── project.woff
    └── project.woff2

Bugs and feature requests

Describe how to report bugs and add feature requests.

Documentation

Link to the documentation docs

Running documentation locally

List steps to get documentation locally.

Documentation for previous releases

Describe how to get documentation for previous releases.

Previous releases

Contributing

Write down how to contribute to the project. Open source contributing is FUN!

Community

Keep track of development and community news.

• Follow @thadbry on Twitter.
• Read and subscribe to The Official Project Blog.
• Chat with your peers in IRC. On the irc.freenode.net server, in the ##whatever channel.
• Implementation help may be found at Stack Overflow (tagged project).

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under the Semantic Versioning guidelines. We adhere to these rules whenever possible. Sometimes we mess up.

Creators

Thad Bryson

• https://twitter.com/ThadBry
• https://github.com/thadbryson

Copyright and license

Here you put the license agreement for code and documentation. I don't recommend any particular license because I don't want to give legal advice. I'm not licensed to practice law in any state. The one I use for this project is linked below. The main README.md file for this project has the licenses.

Code and documentation copyright 2016 Thad Bryson.

Code released under the MIT license. Docs released under Creative Commons.