diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 55 |
1 files changed, 44 insertions, 11 deletions
@@ -1,13 +1,13 @@ = CodeRay -You might want to see the original version of this documentation on -http://rd.cYcnus.de/coderay/doc (use Ctrl+Click to open it in its own frame.) +[- Tired of blue'n'gray? Try the original version of this documentation on +http://rd.cYcnus.de/coderay/doc (use Ctrl+Click to open it in its own frame.) -] == About CodeRay is a Ruby library for syntax highlighting. Syntax highlighting means: You put your code in, and you get it back colored; -Keywords, Strings, Floats, Comments - all in different colors. +Keywords, strings, floats, comments - all in different colors. And with line numbers. *Syntax* *Highlighting*... @@ -23,8 +23,8 @@ Author:: murphy Idea:: licenser Website:: rd.cYcnus.de/coderay[http://rd.cYcnus.de/coderay] Copyright:: (c) 2005 by cYcnus -License:: Not yet decided -Subversion: $Id$ +License:: GNU LGPL; see LICENSE file in the main directory. +Subversion:: $Id$ ----- @@ -32,7 +32,7 @@ Subversion: $Id$ You need RubyGems[http://rubyforge.org/frs/?group_id=126]. - % gem install coderay + % gem install coderay === Dependencies @@ -43,28 +43,61 @@ CodeRay needs Ruby 1.8 and the strscan[http://www.ruby-doc.org/stdlib/libdoc/str == Example Usage (Forgive me, but this is not highlighted.) - require 'coderay' - - hl = CodeRay.html :line_numbers => :column - puts hl.highlight_page "puts 'Hello, world!'", :ruby + require 'coderay' + + hl = CodeRay.html :line_numbers => :column + puts hl.highlight_page "puts 'Hello, world!'", :ruby == Documentation See CodeRay. +Please report errors in this documentation to <coderay cycnus de>. + ----- == Credits === Special Thanks to + * licenser (Heinz N. Gies) for ending my QBasic career, inventing the Coder project and the input/output plugin system. CodeRay would not exist without him. === Thanks to -* Caleb Clausen for writing RubyLexer (see http://rubyforge.org/projects/rubylexer) and lots of mails + +* Caleb Clausen for writing RubyLexer (see http://rubyforge.org/projects/rubylexer) and lots + of very interesting mails traffic * Jamis Buck for writing Syntax (see http://rubyforge.org/projects/syntax) + I got some useful ideas from it. +* Doug Kearns and everyone else who worked on ruby.vim - it not only helped me coding CodeRay, + but also gave me a wonderful target to reach for the Ruby scanner. * everyone who used CodeRay on http://www.rubyforen.de and http://www.infhu.de/mx * iGEL, magichisoka, manveru and everyone I forgot from rubyforen.de * Dookie (who is no longer with us...) and Leonidas from http://www.python-forum.de +* matz, nobu, why, dave, dhh, etc... you know, those Ruby gods and gurus +* The inventors of: the computer, the internet, the true color display, HTML & CSS, VIM, RUBY, + pizza, microwaves, guitars, scouting, programming, anime, manga, coke and green ice tea. + +Where would we be without all those people? + +=== Created using + +* Ruby[http://ruby-lang.org/en/] +* Chihiro (my Sony VAIO laptop) and Seras (my Athlon 2200+ tower) +* VIM[http://vim.org] +* RDE[http://homepage2.nifty.com/sakazuki/rde_e.html] +* Microsoft Windows (yes, I confess!) +* Firefox[http://www.mozilla.org/products/firefox/] and Thunderbird[http://www.mozilla.org/products/thunderbird/] +* Rake[http://rake.rubyforge.org/] +* RubyGems[http://docs.rubygems.org/] +* {Subversion/TortoiseSVN}[http://tortoisesvn.tigris.org/] using Apache via XAMPP[http://www.apachefriends.org/en/xampp.html] +* RDoc (though I'm quite unsatisfied with it) +* GNUWin32, MinGW and some other tools to make the shell under windows a bit more usefull + +--- + +* As you can see, CodeRay was created under heavy use of *free* software. +* So CodeRay is also *free*. +* If you use CodeRay to create software, think about making this software *free*, too. |