====== Using Darcs ======

Ramaze uses the [[http://darcs.net|darcs]] source code management system. For more information about darcs, its features and installation instructions, check out the [[http://wiki.darcs.net/DarcsWiki|darcs wiki]]:

  * [[http://wiki.darcs.net/DarcsWiki/CategoryBinaries|Downloading and Installing Darcs]]
  * [[http://wiki.darcs.net/DarcsWiki/GettingStarted|Getting Started with Darcs]]
  * [[http://en.wikibooks.org/wiki/Understanding_darcs|Understanding Darcs]]

On OSX, use the [[http://www.fivesquaresoftware.com/source/|darcs installer]], which includes the darcs binary, bash completion script and GMP.framework.

The darcs repository for Ramaze is at http://darcs.ramaze.net/ramaze/ and a [[http://darcs.ramaze.net/?r=ramaze;a=summary|web-based front-end]] is also available. Additionally, a [[http://manveru.net/gems/ramaze-nightly/|nightly gem]] is available for those unwilling or unable to install darcs:

  $ wget http://manveru.net/gems/ramaze-nightly/ramaze-nightly.gem
  $ gem install ramaze-nightly.gem

====== Getting Ramaze ======

To get the latest and greatest, just pull from the repository:

  $ darcs get --partial http://darcs.ramaze.net/ramaze

Please read the man page or ''darcs help'' for more information about updating and creating your own patches.

To update to the latest version, run this from inside your working copy of ramaze:

  $ darcs pull

=== Using the repo version ===

To use your new darcs checkout of ramaze, without having to ''rake install'' every time you ''darcs pull'', add a file to your Ruby installation's site_ruby directory named 'ramaze.rb':

  $ cat /usr/lib/ruby/site_ruby/1.8/ramaze.rb
  require 'rubygems'
  require '/where/you/darcs/pulled/ramaze/lib/ramaze'

Then use this in all your code: 

  require 'ramaze'

=== Making a patch ===

Record a patch with:

  $ darcs record

If your machine can send mail, simply let darcs send the patch for you:

  $ darcs send --to=ramaze@googlegroups.com

Otherwise, save the patch to a file:

  $ darcs send -o some-ramaze-bugfix.patch
  $ gzip -c some-ramaze-bugfix.patch > some-ramaze-bugfix.patch.gz

Then throw this .gz file at [[http://groups.google.com/group/ramaze|the google group]], or at manveru on [[irc://chat.freenode.net/ramaze|IRC]].