Download as
Browse Code »

Commit a43dcc0c6cbab1dfe4967ba159990b389fc9f2fc

Authored by Jared Pace
1 parent b98ebd0c
Exists in master and in 1 other branch production

Add MIT License and update the readme

Showing 2 changed files with 55 additions and 5 deletions   Show diff stats
LICENSE 0 → 100644
  Diff comments   View file @a43dcc0
... ... @@ -0,0 +1,20 @@
  1 +Copyright (c) 2010 Jared Pace
  2 +
  3 +Permission is hereby granted, free of charge, to any person obtaining
  4 +a copy of this software and associated documentation files (the
  5 +"Software"), to deal in the Software without restriction, including
  6 +without limitation the rights to use, copy, modify, merge, publish,
  7 +distribute, sublicense, and/or sell copies of the Software, and to
  8 +permit persons to whom the Software is furnished to do so, subject to
  9 +the following conditions:
  10 +
  11 +The above copyright notice and this permission notice shall be
  12 +included in all copies or substantial portions of the Software.
  13 +
  14 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  17 +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  18 +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  19 +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  20 +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0 21 \ No newline at end of file
... ...
README.md
  Diff comments   View file @a43dcc0
... ... @@ -9,7 +9,7 @@ Rails applications. If you're uncomfortable with any step below then Errbit is n
9 9 for you. Checkout [Hoptoad](http://hoptoadapp.com) from the guys over at
10 10 [Thoughbot](http://thoughtbot.com), which Errbit is based on.
11 11  
12   -Set your local box or server(Ubuntu):
  12 +*Set your local box or server(Ubuntu):*
13 13 1. Install MongoDB
14 14 * Follow the directions [here](http://www.mongodb.org/display/DOCS/Ubuntu+and+Debian+packages) then:
15 15  
... ... @@ -23,17 +23,47 @@ Set your local box or server(Ubuntu):
23 23 3. Install Bundler
24 24  
25 25 gem install bundler --pre
  26 +
  27 +*Running Locally:*
  28 + 1. Bootstrap Errbit. This will copy over config.yml and also seed the database.
  29 +
  30 + rake errbit:bootstrap
  31 +
  32 + 2. Update the config.yml and mongoid.yml files with information about your environment
  33 + 3. Install dependencies
  34 +
  35 + bundle install
  36 +
  37 + 4. Start Server
  38 +
  39 + script/rails server
26 40  
27   -Deploy:
  41 +*Deploying:*
28 42 1. Bootstrap Errbit. This will copy over config.yml and also seed the database.
29 43  
30   - rake errbit:bootstrap
  44 + rake errbit:bootstrap
31 45  
32   - 2. Update the config.yml file with information about your server
  46 + 2. Update the deploy.rb file with information about your server
33 47 3. cap deploy:setup deploy
34 48  
35 49 TODO
36 50 ----
37 51  
38 52 Add a deployment view
39   -Add ability for watchers to be configured for types of notifications they should receive
40 53 \ No newline at end of file
  54 +Add ability for watchers to be configured for types of notifications they should receive
  55 +
  56 +Contributing
  57 +------------
  58 +
  59 +* Fork the project.
  60 +* Make your feature addition or bug fix.
  61 +* Add tests for it. This is important so I don't break it in a
  62 + future version unintentionally.
  63 +* Commit, do not mess with Rakefile, version, or history.
  64 + (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)
  65 +* Send me a pull request. Bonus points for topic branches.
  66 +
  67 +Copyright
  68 +---------
  69 +
  70 +Copyright (c) 2010 Jared Pace. See LICENSE for details.
... ...