deac/mailr
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

README fixed

Browse source
This commit is contained in:
Wojciech Todryk 2011-06-25 00:12:21 +02:00
parent 1ea0781ddb
commit 12726a2c3c
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.markdown
View file

@ -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 _<Rails.root>.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.