/github-readme

example github project readme

GITHUB-README

An example README.md file for your Github project which everybody/github starters can use as a start readme file for there own project in MD(MarkDown) format. Don't know what MD syntax is? Check this article by John Gruber.

Quick start

Clone the repo, git clone git@github.com:z3bbster/github-readme.git, or download the latest release.

Bug tracker

Have a bug? Please create an issue here on GitHub!

https://github.com/developer_name/github-readme/issues

Authors

developer_name

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request