Skip to content
Browse files

Added readme template for rails application

  • Loading branch information...
1 parent 25a30ea commit 3b947b974bbdc6da0bb26c483f8b81767555d8b2 @ryanatwork ryanatwork committed
Showing with 114 additions and 0 deletions.
  1. +114 −0 rails.mkd
View
114 rails.mkd
@@ -0,0 +1,114 @@
+# Ruby on Rails Template
+A readme template for Ruby on Rails Applications
+
+## <a name="screenshots"></a>Screenshot
+![Adopt a Hydrant](https://github.com/codeforamerica/adopt-a-hydrant/raw/master/screenshot.png "Adopt a Hydrant")
+
+## <a name="build"></a>Build Status
+[![Build Status](https://secure.travis-ci.org/codeforamerica/cfa_template.png?branch=master)][travis]
+
+[travis]: http://travis-ci.org/codeforamerica/cfa_template
+
+## <a name="dependencies"></a>Dependency Status
+[![Dependency Status](https://gemnasium.com/codeforamerica/cfa_template.png?travis)][gemnasium]
+
+[gemnasium]: https://gemnasium.com/codeforamerica/cfa_template
+
+## <a name="demo"></a>Demo
+You can see a running version of the application at
+[http://cfa_template.herokuapp.com/][demo].
+
+[demo]: http://cfa_template.herokuapp.com/
+
+## <a name="installation"></a>Installation
+ git clone git://github.com/codeforamerica/cfa_template.git
+ cd adopt-a-hydrant
+ bundle install
+ rake db:migrate
+
+## <a name="usage"></a>Usage
+ rails server
+
+## <a name="contributing"></a>Contributing
+In the spirit of [free software][free-sw], **everyone** is encouraged to help
+improve this project.
+
+[free-sw]: http://www.fsf.org/licensing/essays/free-sw.html
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by [translating to a new language][locales]
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up
+ inconsistent whitespace)
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+* [financially][]
+
+[locales]: https://github.com/codeforamerica/cfa_template/tree/master/config/locales
+[issues]: https://github.com/codeforamerica/cfa_template/issues
+[financially]: https://secure.codeforamerica.org/page/contribute
+
+## <a name="issues"></a>Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. You can indicate support for an existing issue by
+voting it up. When submitting a bug report, please include a [Gist][] that
+includes a stack trace and any details that may be necessary to reproduce the
+bug, including your gem version, Ruby version, and operating system. Ideally, a
+bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## <a name="pulls"></a>Submitting a Pull Request
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Add tests for your feature or bug fix.
+5. Run `bundle exec rake test`. If your changes are not 100% covered, go back
+ to step 4.
+6. Commit and push your changes.
+7. Submit a pull request. Please do not include changes to the gemspec or
+ version file. (If you want to create your own version for some reason,
+ please do so in a separate commit.)
+
+## <a name="versions"></a>Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+* [Rubinius][]
+* [Ruby Enterprise Edition][ree]
+
+[rubinius]: http://rubini.us/
+[ree]: http://www.rubyenterpriseedition.com/
+
+If something doesn't work on one of these interpreters, it should be considered
+a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby
+implementations, however support will only be provided for the versions listed
+above.
+
+If you would like this library to support another Ruby version, you may
+volunteer to be a maintainer. Being a maintainer entails making sure all tests
+run and pass on that implementation. When something breaks on your
+implementation, you will be personally responsible for providing patches in a
+timely fashion. If critical issues for a particular implementation exist at the
+time of a major release, support for that Ruby version may be dropped.
+
+## <a name="copyright"></a>Copyright
+Copyright (c) 2011 Code for America. See [LICENSE][] for details.
+
+[license]: https://github.com/codeforamerica/cfa_template/blob/master/LICENSE.mkd
+
+[![Code for America Tracker](http://stats.codeforamerica.org/codeforamerica/cfa_template.png)][tracker]
+
+[tracker]: http://stats.codeforamerica.org/projects/cfa_template

0 comments on commit 3b947b9

Please sign in to comment.
Something went wrong with that request. Please try again.