From a43dcc0c6cbab1dfe4967ba159990b389fc9f2fc Mon Sep 17 00:00:00 2001 From: Jared Pace Date: Mon, 16 Aug 2010 09:03:26 -0400 Subject: [PATCH] Add MIT License and update the readme --- LICENSE | 20 ++++++++++++++++++++ README.md | 40 +++++++++++++++++++++++++++++++++++----- 2 files changed, 55 insertions(+), 5 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a608e22 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Copyright (c) 2010 Jared Pace + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 26f0367..75633de 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ Rails applications. If you're uncomfortable with any step below then Errbit is n for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at [Thoughbot](http://thoughtbot.com), which Errbit is based on. -Set your local box or server(Ubuntu): +*Set your local box or server(Ubuntu):* 1. Install MongoDB * Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages) then: @@ -23,17 +23,47 @@ Set your local box or server(Ubuntu): 3. Install Bundler gem install bundler --pre + +*Running Locally:* + 1. Bootstrap Errbit. This will copy over config.yml and also seed the database. + + rake errbit:bootstrap + + 2. Update the config.yml and mongoid.yml files with information about your environment + 3. Install dependencies + + bundle install + + 4. Start Server + + script/rails server -Deploy: +*Deploying:* 1. Bootstrap Errbit. This will copy over config.yml and also seed the database. - rake errbit:bootstrap + rake errbit:bootstrap - 2. Update the config.yml file with information about your server + 2. Update the deploy.rb file with information about your server 3. cap deploy:setup deploy TODO ---- Add a deployment view -Add ability for watchers to be configured for types of notifications they should receive \ No newline at end of file +Add ability for watchers to be configured for types of notifications they should receive + +Contributing +------------ + +* Fork the project. +* Make your feature addition or bug fix. +* Add tests for it. This is important so I don't break it in a + future version unintentionally. +* Commit, do not mess with Rakefile, version, or history. + (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull) +* Send me a pull request. Bonus points for topic branches. + +Copyright +--------- + +Copyright (c) 2010 Jared Pace. See LICENSE for details. -- libgit2 0.21.2