Changeset 45

Show
Ignore:
Timestamp:
11/19/08 15:42:43 (7 weeks ago)
Author:
deveiant
Message:

Ye gods. Re-re-undoing clobbered README, hopefully for the last time.

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/README

    r44 r45  
    1 = LinkParser 
     1= Ruby-LinkParser 
    22 
    3 LinkParser is a Ruby binding for the link-grammar library.  
     3This module is a Ruby binding for the link-grammar library, a syntactic parser 
     4of English.  
    45 
    5 A Ruby binding for the link-grammar library, a syntactic parser 
    6 of English. See http://www.link.cs.cmu.edu/link/ for more 
    7 information about the Link Grammar, and 
    8 http://www.abisource.org/projects/link-grammar/ for information 
    9 about the link-grammar library.  
     6== Authors 
    107 
    11 In the meantime, you can check out the current development source with Subversion from the  
    12 following URL: 
     8 * Michael Granger <ged@FaerieMUD.org> 
     9 * Martin Chase <stillflame@FaerieMUD.org> 
    1310 
    14     svn://deveiate.org/LinkParser/trunk 
    1511 
    16 The project page is also likely to have more details: 
     12== Requirements 
    1713 
    18     http://deveiate.org/projects/Ruby-LinkParser/ 
     14 * Ruby 1.8.6 
     15 * link-grammar-4.3.9 from the AbiWord project  
     16   (http://www.abisource.com/projects/link-grammar/)  
    1917 
    20 == License 
     18Opitonally, if you want to be able to tell what sublinkage a linkage is currently 
     19set to, you'll need to apply the included patch to the link-grammar library before 
     20you build it. It's entirely optional, though. 
    2121 
    22 See the LICENSE file in the same directory for licensing details. 
     22 
     23=== Example Usage 
     24 
     25  require 'linkparser' 
     26   
     27  dict = LinkParser::Dictionary.new( :screen_width => 100 ) 
     28  sent = dict.parse( "People use Ruby for all kinds of nifty things." ) 
     29  # => #<LinkParser::Sentence:0xcf8eb "LEFT-WALL people use Ruby for all kinds 
     30  #      of nifty things . RIGHT-WALL"/2 linkages/0 nulls> 
     31                 
     32  sent.subject        # => "people" 
     33  sent.verb           # => "use" 
     34  sent.object         # => "Ruby" 
     35   
     36  puts sent.constituent_tree_string 
     37  # => 
     38  # (S (NP People) 
     39  #    (VP use 
     40  #        (NP Ruby) 
     41  #        (PP for 
     42  #            (NP (NP all kinds) 
     43  #                (PP of 
     44  #                    (NP nifty things))))) 
     45  #    .) 
     46   
     47  puts sent.diagram 
     48  # => 
     49  #     +-------------------------------Xp------------------------------+ 
     50  #     |                +----MVp---+----Jp----+     +------Jp-----+    | 
     51  #     +----Wd---+--Sp--+--Os-+    |    +-Dmc-+--Mp-+    +----A---+    | 
     52  #     |         |      |     |    |    |     |     |    |        |    | 
     53  # LEFT-WALL people.p use.v Ruby for.p all kinds.n of nifty.a things.n .  
     54     
     55 
     56== Legal 
     57 
     58For copyright and licensing information for link-grammar itself, see the 
     59LICENSE file in that distribution. 
     60 
     61Copyright (c) 2006-2008, Michael Granger 
     62All rights reserved. 
     63 
     64Redistribution and use in source and binary forms, with or without 
     65modification, are permitted provided that the following conditions are met: 
     66 
     67* Redistributions of source code must retain the above copyright notice, 
     68  this list of conditions and the following disclaimer. 
     69 
     70* Redistributions in binary form must reproduce the above copyright notice, 
     71  this list of conditions and the following disclaimer in the documentation 
     72  and/or other materials provided with the distribution. 
     73 
     74* Neither the name of the author/s, nor the names of the project's 
     75  contributors may be used to endorse or promote products derived from this 
     76  software without specific prior written permission. 
     77 
     78THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
     79AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
     80IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
     81DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
     82FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
     83DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
     84SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
     85CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
     86OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
     87OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
     88 
     89 
     90 $Id$ 
     91 
     92