Permalink
Browse files

Slightly improved documentation.

Also added proper LICENSE file.
  • Loading branch information...
1 parent 9295f10 commit 3f190edd772c1f109b18c0e4fa9d5121dc85aeca @oneiros committed Oct 24, 2011
Showing with 43 additions and 5 deletions.
  1. +24 −0 LICENSE
  2. +9 −5 README.md
  3. +10 −0 config/settings.yml.template
View
24 LICENSE
@@ -0,0 +1,24 @@
+Note that Kalua depends on and bundles software that might be
+licensed differently. The following refers to code that is original
+to Kalua.
+
+Copyright (c) 2011 David Roetzel
+
+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.
View
@@ -26,7 +26,7 @@ than 5 parallel tracks over 2 days.
## Installing
-frab is a pretty standard Ruby on Rails (version 3) application.
+frab is a pretty standard Ruby on Rails (version 3.1) application.
There should be plenty of tutorials online on how to install,
deploy and setup these.
@@ -49,14 +49,18 @@ Basically, to get started you need to:
cp config/database.yml.template config/database.yml
frab bundles all three built-in rails database drivers.
-And it should work with all three, alhtough it is best tested
+And it should work with all three, although it is best tested
with MySQL and SQLite3 (for development).
-5) Create and setup the database
+5) Create and modify settings:
+
+ cp config/settings.yml.template config/settings.yml
+
+6) Create and setup the database
rake db:setup
-6) Start the server
+7) Start the server
rails server
@@ -84,4 +88,4 @@ from there.
frab is licensed under an MIT-License. It bundles some
third-party libraries and assets that might be licensed
-differently.
+differently. See LICENSE.
@@ -1,7 +1,9 @@
development:
+ # Host configuration used to generate links in emails
host: localhost
port: 3000
protocol: http
+ # Default 'From' address, used when sending emails
from_email: frab@localhost
test:
@@ -10,5 +12,13 @@ test:
from_email: frab@frab.test
production:
+ # no need to specify port, when default (80) is used
host: frab.example.com
protocol: https
+ from_email: noreply@frab.example.com
+ # smtp server settings. see
+ # http://api.rubyonrails.org/classes/ActionMailer/Base.html
+ # for all available options
+ smtp_settings:
+ address: localhost
+

0 comments on commit 3f190ed

Please sign in to comment.