Skip to content

Commit

Permalink
Markdown readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
dirkkelly authored and saturnflyer committed Mar 15, 2012
1 parent 1044def commit 27f2a8d
Showing 1 changed file with 15 additions and 35 deletions.
50 changes: 15 additions & 35 deletions README.md
Expand Up @@ -27,58 +27,38 @@ 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
## Installation

Radiant is a traditional Ruby on Rails application, meaning that you can
configure and run it the way you would a normal Rails application.
The aim is to have everything served from your Gemfile

See the INSTALL file for more details.
gem 'radiant'
gem 'radiant-archive-extension'
gem 'radiant-layouts-extension'

### Installation of a Prerelease
## Development

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 sqlite3-ruby
* Fork the project
* Write tests in tests/railsapp/specs
* Modify code in the root directory
* Continue hacking ...
* Send a pull request

## Support

The best place to get support is on the mailing list:

http://radiantcms.org/mailing-list/
[http://radiantcms.org/mailing-list/](http://radiantcms.org/mailing-list/)

Most of the development for Radiant happens on Github:

http://github.com/radiant/radiant/
[http://github.com/radiant/radiant/](http://github.com/radiant/radiant/)

The project wiki is here:

http://wiki.github.com/radiant/radiant/

[http://wiki.github.com/radiant/radiant/](http://wiki.github.com/radiant/radiant/)

Enjoy!

--
The Radiant Dev Team
http://radiantcms.org
http://radiantcms.org

0 comments on commit 27f2a8d

Please sign in to comment.