Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jcwilk committed Aug 23, 2010
1 parent 00ca201 commit e0efc8a
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
File renamed without changes.
5 changes: 4 additions & 1 deletion README.rdoc
Expand Up @@ -12,12 +12,15 @@ I've been having issues trying to use this gem so I decided to upload it to gith

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.
It seems like using version 1.6.1 of the java StanfordParser package is your best bet for compatability.

See README.orig.rdoc for Bill's readme, which includes dependencies, installation, and usage.

== Branches

* master - Jeweler and Bundler integrated along with slight reorganization of files to be more gem-standard. This is the branch you should use if you want to source the gem straight from github. I will leave this branch alone for the most part unless I find/come up with stable and useful additions. All changes will be backwards compatible.
* stock - Almost untouched from Bill's version, except for the README. Use this branch if that's what you're looking for.
* fixing_tests - The tests are currently broken, this branch is trying to address that. Once the tests are fixed it will be merged back into master. Help appreciated! I'll keep a TESTS_STATUS.rdoc keeping track of progress.
* experimental - I'll be putting in some code as examples and testing out some ideas. Do not use this branch as a gem. You are very encouraged, however, to fork it and add some code/make my code better. I'll try to integrate all the pull requests I get, if not in that branch into another.

== Note on Patches/Pull Requests
Expand Down
2 changes: 2 additions & 0 deletions TESTS_STATUS.rdoc
@@ -0,0 +1,2 @@
= Status of Tests
* Please see fixing_tests branches for efforts towards this goal.

0 comments on commit e0efc8a

Please sign in to comment.