README.markdown

   1 merb\_radiant README
   2 ===================
   3
   4 merb\_radiant is the codename for a port of popular Radiant Content Management
   5 System (CMS) to the merb MVC framework.
   6
   7 **WARNING** : merb\_radiant is in early porting stage, and should only be
   8 considered for consumption by reasonably advanced Ruby and merb developers.
   9
  10 Features of merb\_radiant include:
  11
  12   * an elegant user interface
  13   * the ability to arrange pages in a hierarchy
  14   * a flexible templating system providing layouts, snippets, page parts,
  15     and a custom tagging language (Radius: <http://radius.rubyforge.org>)
  16   * a simple user management and permissions system
  17   * support for both the Markdown and Textile syntaxes, vanilla HTML, and the
  18     ability to develop and plug in your own alternative filters.
  19   * an advanced plugin system
  20   * operation in two modes: development and production, depending on the URL
  21   * a caching system which expires pages every 5 minutes
  22   * built on the cutting-edge, fast Merb framework.
  23   * and much more...
  24
  25 Installation and Setup
  26 ----------------------
  27
  28 Please see the INSTALL file details on getting merb\_radiant up and running.
  29
  30 Getting the Source
  31 ------------------
  32
  33 Performing a git clone of one of the following repositories will get you the
  34 latest source:
  35
  36     git clone git://github.com/myabc/merb_radiant.git
  37     git clone git://gitorious.org/merb_radiant/myabc-clone.git (on gitorious)
  38
  39     git clone git://github.com/sbusso/merb_radiant.git
  40     git clone git://gitorious.org/merb_radiant/mainline.git (on gitorious)
  41
  42 The following additional mirrors are available:
  43
  44     git://repo.or.cz/merb_radiant.git
  45     http://repo.or.cz/r/merb_radiant.git
  46
  47 Licensing and Copyright
  48 -----------------------
  49
  50 merb\_radiant is released under an **MIT license**. Copyright information, as
  51 well as a copy of the MIT license may found in the LICENSE.txt file.
  52
  53 Support
  54 -------
  55
  56 merb\_radiant is in early porting stage, so full support infrastructure is not
  57 yet in place.
  58
  59  * For now, please check out the porting wiki:
  60   <http://github.com/sbusso/merb_radiant/wikis>
  61
  62  * You may also contact the developers directly:
  63    - <alex@alexcolesportfolio.com>
  64
  65 You can also try the Radiant CMS mailing list for information relating to
  66 Radiant CMS, the original Ruby on Rails-powered CMS:
  67 <http://radiantcms.org/mailing-list/>
  68