Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 85 lines (51 sloc) 2.322 kb
2196691 @will-r readme in markdown with travis badge
will-r authored
1 ## Welcome to Radiant
2
3 Radiant is a no-fluff, open source content management system designed for
4 small teams. It is similar to Textpattern or MovableType, but is a general
5 purpose content management system (not just a blogging engine).
6
589aaf4 @johnmuhl use travis badge specific to the master branch
johnmuhl authored
7 [![Build Status](https://secure.travis-ci.org/radiant/radiant.png?branch=master)](http://travis-ci.org/radiant/radiant)
2196691 @will-r readme in markdown with travis badge
will-r authored
8
9 Radiant features:
10
11 * An elegant user interface
12 * The ability to arrange pages in a hierarchy
13 * Flexible templating with layouts, snippets, page parts, and a custom tagging
14 language (Radius: http://radius.rubyforge.org)
15 * A simple user management/permissions system
16 * Support for Markdown and Textile as well as traditional HTML (it's easy to
17 create other filters)
18 * An advanced plugin system
19 * Operates in two modes: dev and production depending on the URL
20 * A caching system which expires pages every 5 minutes
21 * Built using Ruby on Rails
22 * And much more...
23
24 ## License
25
26 Radiant is released under the MIT license and is copyright (c) 2006-2009
27 John W. Long and Sean Cribbs. A copy of the MIT license can be found in the
28 LICENSE file.
29
30 ## Installation and Setup
31
32 Radiant is a traditional Ruby on Rails application, meaning that you can
33 configure and run it the way you would a normal Rails application.
34
35 See the INSTALL file for more details.
36
37 ### Installation of a Prerelease
38
39 As Radiant nears newer releases, you can experiment with any prerelease version.
40
41 Install the prerelease gem with the following command:
42
43 $ gem install radiant --prerelease
44
45 This will install the gem with the prerelease name, for example: ‘radiant-0.9.0.rc2’.
46
47 ### Upgrading an Existing Project to a newer version
48
49 1. Update the Radiant assets from in your project:
50
51 $ rake radiant:update
52
53 2. Migrate the database:
54
55 $ rake production db:migrate
56
57 3. Restart the web server
58
59 ## Development Requirements
60
61 To run tests you will need to have the following gems installed:
62
849f31c @micrypt Added in sqlite3-ruby as it's no longer in the dependencies.
micrypt authored
63 gem install ZenTest rspec rspec-rails cucumber webrat nokogiri sqlite3-ruby
2196691 @will-r readme in markdown with travis badge
will-r authored
64
65 ## Support
66
67 The best place to get support is on the mailing list:
68
69 http://radiantcms.org/mailing-list/
70
71 Most of the development for Radiant happens on Github:
72
73 http://github.com/radiant/radiant/
74
75 The project wiki is here:
76
77 http://wiki.github.com/radiant/radiant/
78
79
80 Enjoy!
81
82 --
83 The Radiant Dev Team
84 http://radiantcms.org
Something went wrong with that request. Please try again.