@@ -1,3 +1,7 @@ +=== Edge + +* Mentioned the three supported platforms and what's necessary to build RedCloth in the README file. + === 4.1.1 / November 19, 2008 * Added 'lib/case_sensitive_require' back into gemspec. It got left out in the conversion to echoe, so "require 'RedCloth'" didn't work. #88 CHANGELOG @@ -15,10 +15,38 @@ RedCloth is a Ruby library for converting Textile into HTML. RedCloth can be installed via RubyGems: - sudo gem install RedCloth + gem install RedCloth + +It will install the appropriate Ruby, JRuby, or Win32 gem. If using JRuby, version 1.1.5 or greater is required. + +== Compiling + +If you just want to use RedCloth, you do NOT need to build/compile it. It is compiled from C sources automatically when you install the gem on the ruby platform. Binary gems are provided for JRuby and Win32 platforms. + +RedCloth can be compiled with <tt>rake compile</tt>. Ragel 6.3 or greater and the +echoe gem are needed to build, compile, and package RedCloth. Again, Ragel and echoe are NOT needed to simply use RedCloth. + +You can cross-compile for JRuby with rake java compile and for Win32 with rake mingw compile. + +== Using RedCloth + +RedCloth is simply an extension of the String class, which can handle +Textile formatting. Use it like a String and output HTML with its +RedCloth#to_html method. + +Simple use: + text = "This is *my* text." + RedCloth.new(text).to_html + +Multi-line example: + + doc = RedCloth.new <<EOD + h2. Test document + + Just a simple test. + EOD + puts doc.to_html -Or can be compiled from its Ragel source with <tt>rake compile</tt>. Ragel 6.2 -or greater is required to build RedCloth. == What is Textile? @@ -140,17 +168,4 @@ Styles are applied with curly braces. table{border:1px solid black}. {background:#ddd;color:red}. |a|red|row| -== Using RedCloth - -RedCloth is simply an extension of the String class, which can handle -Textile formatting. Use it like a String and output HTML with its -RedCloth#to_html method. - - doc = RedCloth.new " - - h2. Test document - - Just a simple test." - - puts doc.to_html README 8e2616157a19834f8f4bf8b6383553b93433e48a Jason Garber jg@jasongarber.com http://github.com/ROFISH/redcloth/commit/b331934fecfa9f7fb6b3a12e8b4c46c7f04d6c4f b331934fecfa9f7fb6b3a12e8b4c46c7f04d6c4f 2008-12-03T11:13:08-08:00 2008-12-03T11:13:08-08:00 Mentioned the three supported platforms and what's necessary to build RedCloth in the README file. 648cb8f6e7a2e55eec279e67383c7caed48df351 Jason Garber jg@jasongarber.com