Skip to content

Instantly share code, notes, and snippets.

@mxaly

mxaly/readme_example.md

Last active August 29, 2015 14:21
Show Gist options
  • Save mxaly/b560e55d49c1dc63e9ea to your computer and use it in GitHub Desktop.
Save mxaly/b560e55d49c1dc63e9ea to your computer and use it in GitHub Desktop.
Download ZIP
Raw
readme_example.md

[NAME OF YOUR APPLICATION]

[badge]

[Describe you appliaction]

[link to changelog]

Technology stack

Prerequisites

You will need the following things properly installed on your computer.

  • [list requirmients here]

Installation

  • [list installatino steps]

Running / Development

  • [list how to run app]

Running Tests

[tell how run specs]

Deploying

[tell how deploy changes]

Code style

[few words about style guide]

Further Reading / Useful Links

[share usefull info]

Contributing

  • Fork it ( https://github.com/netguru/app_konfig/fork )
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request

[link to your license]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment