Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Slightly improved documentation.

Also added proper LICENSE file.
  • Loading branch information...
commit 3f190edd772c1f109b18c0e4fa9d5121dc85aeca 1 parent 9295f10
David Roetzel authored
24  LICENSE
... ...
@@ -0,0 +1,24 @@
  1
+Note that Kalua depends on and bundles software that might be
  2
+licensed differently. The following refers to code that is original
  3
+to Kalua.
  4
+
  5
+Copyright (c) 2011 David Roetzel
  6
+
  7
+Permission is hereby granted, free of charge, to any person obtaining
  8
+a copy of this software and associated documentation files (the
  9
+"Software"), to deal in the Software without restriction, including
  10
+without limitation the rights to use, copy, modify, merge, publish,
  11
+distribute, sublicense, and/or sell copies of the Software, and to
  12
+permit persons to whom the Software is furnished to do so, subject to
  13
+the following conditions:
  14
+
  15
+The above copyright notice and this permission notice shall be
  16
+included in all copies or substantial portions of the Software.
  17
+
  18
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  19
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  22
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  23
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  24
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14  README.md
Source Rendered
@@ -26,7 +26,7 @@ than 5 parallel tracks over 2 days.
26 26
 
27 27
 ## Installing
28 28
 
29  
-frab is a pretty standard Ruby on Rails (version 3) application. 
  29
+frab is a pretty standard Ruby on Rails (version 3.1) application. 
30 30
 There should be plenty of tutorials online on how to install,
31 31
 deploy and setup these.
32 32
 
@@ -49,14 +49,18 @@ Basically, to get started  you need to:
49 49
     cp config/database.yml.template config/database.yml
50 50
 
51 51
 frab bundles all three built-in rails database drivers. 
52  
-And it should work with all three, alhtough it is best tested 
  52
+And it should work with all three, although it is best tested 
53 53
 with MySQL and SQLite3 (for development). 
54 54
 
55  
-5) Create and setup the database
  55
+5) Create and modify settings:
  56
+
  57
+    cp config/settings.yml.template config/settings.yml
  58
+
  59
+6) Create and setup the database
56 60
 
57 61
     rake db:setup
58 62
 
59  
-6) Start the server
  63
+7) Start the server
60 64
 
61 65
     rails server
62 66
 
@@ -84,4 +88,4 @@ from there.
84 88
 
85 89
 frab is licensed under an MIT-License. It bundles some
86 90
 third-party libraries and assets that might be licensed
87  
-differently.
  91
+differently. See LICENSE.
10  config/settings.yml.template
... ...
@@ -1,7 +1,9 @@
1 1
 development:
  2
+  # Host configuration used to generate links in emails
2 3
   host: localhost
3 4
   port: 3000
4 5
   protocol: http
  6
+  # Default 'From' address, used when sending emails
5 7
   from_email: frab@localhost
6 8
 
7 9
 test:
@@ -10,5 +12,13 @@ test:
10 12
   from_email: frab@frab.test
11 13
 
12 14
 production:
  15
+  # no need to specify port, when default (80) is used
13 16
   host: frab.example.com
14 17
   protocol: https
  18
+  from_email: noreply@frab.example.com
  19
+  # smtp server settings. see
  20
+  # http://api.rubyonrails.org/classes/ActionMailer/Base.html
  21
+  # for all available options
  22
+  smtp_settings:
  23
+    address: localhost
  24
+

0 notes on commit 3f190ed

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