Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Moved and updated README

  • Loading branch information...
commit b6b98c9479f7333497c2152a69884ba23ecd20a1 1 parent 774ca96
@jcwilk authored
Showing with 28 additions and 17 deletions.
  1. +0 −17 README
  2. +28 −0 README.rdoc
View
17 README
@@ -1,17 +0,0 @@
-This is an upload of Bill McNeal's stanfordparser rubygem, check it out at its homepage (seems to be partially in French)
-
-http://rubyforge.org/projects/stanfordparser/
-
-or its rdocs
-
-http://stanfordparser.rubyforge.org/
-
-I'll probably be extending this in alternate branches as I use it to prod at the Stanford Parser. For now, I've decided to leave master totally stock except for this README explaining it, unless I come up with stuff that I think would compliment Bill's work and would be useful to others.
-
-AFAIK there aren't other copies of this on github, please correct me if I'm mistaken. The only similar one I can see is http://github.com/tiendung/ruby-nlp which has much less code and I can only assume to be something else.
-
-See README.orig for Bill's readme, which includes dependencies, installation, and usage.
-
-
-Sincerely,
-John Wilkinson
View
28 README.rdoc
@@ -0,0 +1,28 @@
+= stanfordparser
+
+This is an upload/extension of Bill McNeal's stanfordparser rubyforge gem, check it out at its homepage (seems to be partially in French)
+
+http://rubyforge.org/projects/stanfordparser/
+
+or its rdocs
+
+http://stanfordparser.rubyforge.org/
+
+I've been having issues trying to use this gem so I decided to upload it to github and try to organize it to be a little more gem-friendly, especially using jeweler.
+
+AFAIK there aren't other copies of this on github, please correct me if I'm mistaken. The only similar one I can see is http://github.com/tiendung/ruby-nlp which has much less code and I can only assume to be something else.
+
+See README.orig for Bill's readme, which includes dependencies, installation, and usage.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. I would prefer rSpec, but TestUnit is acceptable as well since there are some of those from the original author.
+* Commit.
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 John Wilkinson. See LICENSE for details.
+Copyright 2007-2008, William Patrick McNeill. See README.orig for details.

0 comments on commit b6b98c9

Please sign in to comment.
Something went wrong with that request. Please try again.