Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

indicate that this repo is dead. please use bluecloth 2.0 or RDiscount

  • Loading branch information...
commit aa8be0dc8dd71c103dd6593d4200ad2b7aab7d88 1 parent 6cb27aa
@mislav authored
Showing with 6 additions and 64 deletions.
  1. +6 −64 README.markdown
View
70 README.markdown
@@ -1,15 +1,15 @@
BlueCloth
=========
-<i>Forked by <a href="http://github.com/mislav"><strong>Mislav</strong></a> on April 9, 2008</i>
+<i><strong>Important:</strong> this repository is abandoned in favor of much
+quicker implementations such as [bluecloth 2.0][2] and RDiscount.</i>
-This is **a fork of BlueCloth 1.0.0** (2004/08/24) from [its
-trunk](svn://deveiate.org/BlueCloth/trunk). It's been created to finally fix
-some of the outstanding bugs in its abandoned implementation.
+This is **a fork of BlueCloth 1.0.0** (2004/08/24) from its trunk. It's been
+created to fix some of the outstanding bugs in its implementation.
The plan is to first clean up the messy test suite (using RSpec), make existing
tests pass (a lot of them fail right now) and, finally, add tests for annoying
-bugs and making them pass also. Feel free to help out.
+bugs and making them pass also.
I also want to break down its implementation not to be entirely contained in
one file ("lib/bluecloth.rb") anymore. Together with a nicer test suite, that
@@ -27,63 +27,5 @@ tool for web writers. To quote from the project page: Markdown allows you to
write using an easy-to-read, easy-to-write plain text format, then convert it to
structurally valid XHTML (or HTML).
-It borrows a naming convention and several helpings of interface from
-[Redcloth][2], [Why the Lucky Stiff][3]'s processor for a similar text-to-HTML
-conversion syntax called [Textile][4].
-
-
-Installation
-------------
-
-You can install this module either by running the included `install.rb` script,
-or by simply copying `lib/bluecloth.rb` to a directory in your load path.
-
-
-Dependencies
-------------
-
-BlueCloth uses the `StringScanner` class from the `strscan` library, which comes
-with Ruby 1.8.x and later or may be downloaded from the RAA for earlier
-versions, and the `logger` library, which is also included in 1.8.x and later.
-
-
-Example Usage
--------------
-
-The BlueCloth class is a subclass of Ruby's String, and can be used thusly:
-
- bc = BlueCloth::new( str )
- puts bc.to_html
-
-This `README` file is an example of Markdown syntax. The sample program
-`bluecloth` in the `bin/` directory can be used to convert this (or any other)
-file with Markdown syntax into HTML:
-
- $ bin/bluecloth README > README.html
-
-
-Acknowledgements
-----------------
-
-This library is a port of the canonical Perl one, and so owes most of its
-functionality to its author, John Gruber. The bugs in this code are most
-certainly an artifact of my porting it and not an artifact of the excellent code
-from which it is derived.
-
-It also, as mentioned before, borrows its API liberally from RedCloth, both for
-compatibility's sake, and because I think Why's code is beautiful. His excellent
-code and peerless prose have been an inspiration to me, and this module is
-intended as the sincerest flattery.
-
-Also contributing to any success this module may enjoy are those among my peers
-who have taken the time to help out, either by submitting patches, testing, or
-offering suggestions and review:
-
-* Martin Chase <stillflame@FaerieMUD.org>
-* Florian Gross <flgr@ccan.de>
-
-
[1]: http://daringfireball.net/projects/markdown/
-[2]: http://www.whytheluckystiff.net/ruby/redcloth/
-[3]: http://www.whytheluckystiff.net/
-[4]: http://www.textism.com/tools/textile/
+[2]: http://deveiate.org/projects/BlueCloth/
Please sign in to comment.
Something went wrong with that request. Please try again.