-
Notifications
You must be signed in to change notification settings - Fork 346
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
readme in markdown with travis badge
- Loading branch information
Showing
1 changed file
with
84 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Original file line | Diff line number | Diff line change |
---|---|---|---|
@@ -0,0 +1,84 @@ | |||
## Welcome to Radiant | |||
|
|||
Radiant is a no-fluff, open source content management system designed for | |||
small teams. It is similar to Textpattern or MovableType, but is a general | |||
purpose content management system (not just a blogging engine). | |||
|
|||
+[![Build Status](http://travis-ci.org/radiant/radiant.png)](http://travis-ci.org/radiant/radiant) | |||
|
|||
Radiant features: | |||
|
|||
* An elegant user interface | |||
* The ability to arrange pages in a hierarchy | |||
* Flexible templating with layouts, snippets, page parts, and a custom tagging | |||
language (Radius: http://radius.rubyforge.org) | |||
* A simple user management/permissions system | |||
* Support for Markdown and Textile as well as traditional HTML (it's easy to | |||
create other filters) | |||
* An advanced plugin system | |||
* Operates in two modes: dev and production depending on the URL | |||
* A caching system which expires pages every 5 minutes | |||
* Built using Ruby on Rails | |||
* And much more... | |||
|
|||
## License | |||
|
|||
Radiant is released under the MIT license and is copyright (c) 2006-2009 | |||
John W. Long and Sean Cribbs. A copy of the MIT license can be found in the | |||
LICENSE file. | |||
|
|||
## Installation and Setup | |||
|
|||
Radiant is a traditional Ruby on Rails application, meaning that you can | |||
configure and run it the way you would a normal Rails application. | |||
|
|||
See the INSTALL file for more details. | |||
|
|||
### Installation of a Prerelease | |||
|
|||
As Radiant nears newer releases, you can experiment with any prerelease version. | |||
|
|||
Install the prerelease gem with the following command: | |||
|
|||
$ gem install radiant --prerelease | |||
|
|||
This will install the gem with the prerelease name, for example: ‘radiant-0.9.0.rc2’. | |||
|
|||
### Upgrading an Existing Project to a newer version | |||
|
|||
1. Update the Radiant assets from in your project: | |||
|
|||
$ rake radiant:update | |||
|
|||
2. Migrate the database: | |||
|
|||
$ rake production db:migrate | |||
|
|||
3. Restart the web server | |||
|
|||
## Development Requirements | |||
|
|||
To run tests you will need to have the following gems installed: | |||
|
|||
gem install ZenTest rspec rspec-rails cucumber webrat nokogiri | |||
|
|||
## Support | |||
|
|||
The best place to get support is on the mailing list: | |||
|
|||
http://radiantcms.org/mailing-list/ | |||
|
|||
Most of the development for Radiant happens on Github: | |||
|
|||
http://github.com/radiant/radiant/ | |||
|
|||
The project wiki is here: | |||
|
|||
http://wiki.github.com/radiant/radiant/ | |||
|
|||
|
|||
Enjoy! | |||
|
|||
-- | |||
The Radiant Dev Team | |||
http://radiantcms.org |