From 12726a2c3c437bd00f3f2f3f867a41093e39479d Mon Sep 17 00:00:00 2001 From: Wojciech Todryk Date: Sat, 25 Jun 2011 00:12:21 +0200 Subject: [PATCH] README fixed --- README.markdown | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.markdown b/README.markdown index 385a781..4865c89 100644 --- a/README.markdown +++ b/README.markdown @@ -6,12 +6,14 @@ _Mailr_ is a IMAP mail client based on _Ruby on Rails_ platform. **NOTE** All path and filenames are based on _Rails.root_ directory. ### Requirements + In _Rails 3_ all dependencies should be defined in file _.Gemfile_. All needed gems can be installed using bundler. ### Installation procedure -1. Checkout the source code. -2. If you need to override some of the default constants used in the application take a look at config/default_site.rb. Then create config/site.rb that contains only the keys which you want to override. Example content of config/site.rb is: +* Checkout the source code. + +* If you need to override some of the default constants used in the application take a look at config/default_site.rb. Then create config/site.rb that contains only the keys which you want to override. Example content of config/site.rb is: ```ruby module CDF @@ -22,7 +24,7 @@ LOCALCONFIG = { end ``` -3. Configure SMTP settings +* Configure SMTP settings ```ruby # initializers/smtp_settings.rb @@ -36,10 +38,10 @@ end } ``` -4. Prepare config/database.yml file (see config/database.yml.example). +* Prepare config/database.yml file (see config/database.yml.example). Check if proper gems (sqlite3/mysql/postgresql) are defined in _Gemfile_ and installed. -5. Migrate database (rake db:migrate) +* Migrate database (rake db:migrate) -6. Use it. +* Use it.