Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 59 lines (41 sloc) 3.069 kB
bf19f08 @GBH upgrading codemirror. now with line wrapping!
GBH authored
1 # ComfortableMexicanSofa (Rails 3 CMS Engine)
2 [![Build Status](https://secure.travis-ci.org/comfy/comfortable-mexican-sofa.png)](http://travis-ci.org/comfy/comfortable-mexican-sofa) [![Dependency Status](https://gemnasium.com/comfy/comfortable-mexican-sofa.png)](https://gemnasium.com/comfy/comfortable-mexican-sofa)
87f3641 @GBH regex thing for the first tag
GBH authored
3
7bf66da @GBH updating readme a bit
GBH authored
4 ComfortableMexicanSofa is a powerful CMS Engine for your Rails 3 applications.
503c1e1 @GBH updating readme
GBH authored
5
6 Features
7 --------
602e51b @GBH different 404 handling
GBH authored
8 * Simple integration with Rails 3 apps (with or without assets pipeline)
7bf66da @GBH updating readme a bit
GBH authored
9 * Build your application in Rails, not in CMS
7bdb64a @GBH changing links
GBH authored
10 * Powerful page templating capability using [Tags](https://github.com/comfy/comfortable-mexican-sofa/wiki/Tags)
11 * [Multiple Sites](https://github.com/comfy/comfortable-mexican-sofa/wiki/Sites) from a single installation
503c1e1 @GBH updating readme
GBH authored
12 * Multilingual
7bdb64a @GBH changing links
GBH authored
13 * [Fixtures](https://github.com/comfy/comfortable-mexican-sofa/wiki/Working-with-CMS-fixtures) for initial content population
14 * [Revision History](https://github.com/comfy/comfortable-mexican-sofa/wiki/Revisions)
15 * [Great reusable admin interface](https://github.com/comfy/comfortable-mexican-sofa/wiki/Reusing-sofa%27s-admin-area)
503c1e1 @GBH updating readme
GBH authored
16 * Almost no 3rd party library dependencies
9e12898 @GBH updated gemspec and even some README
GBH authored
17
18 Installation
19 ------------
20 Add gem definition to your Gemfile:
21
52b49d8 @siong1987 use gem in Gemfile instead of config.gem in Rails 3.
siong1987 authored
22 gem 'comfortable_mexican_sofa'
9e12898 @GBH updated gemspec and even some README
GBH authored
23
24 Then from the Rails project's root run:
5f9eceb @GBH adjusting tokenizer regex again
GBH authored
25
9e12898 @GBH updated gemspec and even some README
GBH authored
26 bundle install
9a208b6 @GBH adjusting generator and some minor css stuff
GBH authored
27 rails generate comfy:cms
9e12898 @GBH updated gemspec and even some README
GBH authored
28 rake db:migrate
29
7bdb64a @GBH changing links
GBH authored
30 When upgrading from the older version please take a look at [Upgrading ComfortableMexicanSofa](https://github.com/comfy/comfortable-mexican-sofa/wiki/Upgrading-ComfortableMexicanSofa)
b24e328 @GBH adding a note about upgrading
GBH authored
31
503c1e1 @GBH updating readme
GBH authored
32 Quick Start Guide
33 -----------------
f09393a @GBH rewrote readme
GBH authored
34 After finishing installation you should be able to navigate to http://yoursite/cms-admin
9e12898 @GBH updated gemspec and even some README
GBH authored
35
7bdb64a @GBH changing links
GBH authored
36 Default username and password is 'username' and 'password'. You probably want to change it right away. Admin credentials (among other things) can be found and changed in the cms initializer: [/config/initializers/comfortable\_mexican\_sofa.rb](https://github.com/comfy/comfortable-mexican-sofa/blob/master/config/initializers/comfortable_mexican_sofa.rb)
9e12898 @GBH updated gemspec and even some README
GBH authored
37
503c1e1 @GBH updating readme
GBH authored
38 Before creating pages and populating them with content we need to create a Site. Site defines a hostname, content path and it's language.
39
40 After creating a Site, you need to make a Layout. Layout is the template of your pages; it defines some reusable content (like header and footer, for example) and places where the content goes. A very simple layout can look like this:
f09393a @GBH rewrote readme
GBH authored
41
9e12898 @GBH updated gemspec and even some README
GBH authored
42 <html>
43 <body>
f09393a @GBH rewrote readme
GBH authored
44 <h1>{{ cms:page:header:string }}</h1>
45 {{ cms:page:content:text }}
9e12898 @GBH updated gemspec and even some README
GBH authored
46 </body>
47 </html>
48
0176c1e @GBH Tweaking documentation a bit
GBH authored
49 Once you have a layout, you may start creating pages and populating content. It's that easy.
5f87bb4 @GBH adding more documentation
GBH authored
50
7bdb64a @GBH changing links
GBH authored
51 For more information please [see Wiki pages](https://github.com/comfy/comfortable-mexican-sofa/wiki).
7bf66da @GBH updating readme a bit
GBH authored
52
7bdb64a @GBH changing links
GBH authored
53 ![Sofa's Page Edit View](https://github.com/comfy/comfortable-mexican-sofa/raw/master/doc/preview.png)
478e636 @GBH adding a screenshot
GBH authored
54
490d7aa @GBH drawing a line
GBH authored
55 ---
56
7bdb64a @GBH changing links
GBH authored
57 ComfortableMexicanSofa is released under the [MIT license](https://github.com/comfy/comfortable-mexican-sofa/raw/master/LICENSE)
b24e328 @GBH adding a note about upgrading
GBH authored
58
59 Copyright 2009-2011 Oleg Khabarov, [The Working Group Inc](http://www.twg.ca)
Something went wrong with that request. Please try again.