Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Markdown readme file

  • Loading branch information...
commit da0bbd315447be94808671eb3b4b59cef71e40d8 1 parent 5daa7c7
Dirk Kelly authored
Showing with 18 additions and 41 deletions.
  1. +18 −41 README → README.md
View
59 README → README.md
@@ -1,4 +1,4 @@
-== Welcome to Radiant
+## 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
@@ -19,67 +19,44 @@ Radiant features:
* Built using Ruby on Rails
* And much more...
-
-== License
+## 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
-== 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’.
+The aim is to have everything served from your Gemfile
-== Upgrading an Existing Project to a newer version
+ gem 'radiant'
+ gem 'radiant-archive-extension'
+ gem 'radiant-layouts-extension'
-1. Update the Radiant assets from in your project:
+## Development
- $ rake radiant:update
+* Fork the project
+* Write tests in tests/railsapp/specs
+* Modify code in the root directory
+* Continue hacking ...
+* Send a pull request
-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
+## 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
Please sign in to comment.
Something went wrong with that request. Please try again.