https://github.com/rubyworks/english
English language support library
https://github.com/rubyworks/english
Last synced: 6 months ago
JSON representation
English language support library
- Host: GitHub
- URL: https://github.com/rubyworks/english
- Owner: rubyworks
- License: other
- Created: 2009-10-03T12:32:36.000Z (over 16 years ago)
- Default Branch: master
- Last Pushed: 2016-10-14T15:00:41.000Z (over 9 years ago)
- Last Synced: 2023-04-10T08:21:02.926Z (almost 3 years ago)
- Language: Ruby
- Homepage: http://rubygengo.github.com/english
- Size: 1.43 MB
- Stars: 31
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.rdoc
- Changelog: HISTORY.rdoc
- License: LICENSE
Awesome Lists containing this project
README
= English
* home: http://rubyworks.github.com/english
* work: http://github.com/rubyworks/english
== DESCRIPTION
English is a spin-off of Facets, collecting together all English
language libraries together under a single unified project. The English
project intends to provided a general purpose set of English-oriented
text manipulation and natural language processing Ruby libraries in one
convenient package.
== RELEASE NOTES
Please see the HISTORY file.
== SYNOPSIS
The primary means of usage is via the English::String class.
A normal Ruby +String+ can be quickly concerted to an +English::String+
class using the +#en+ method. With the converted object you can
call any of the string-based English methods.
require 'english/inflect'
"Goose".en.plural #=> "Geese"
By loading the 'language/mixin' library, you can further remove
the need for the #en method. Instead the Language module will
use whatever language is set as *current*. By default 'en' is
the current language setting.
require 'language/mixin'
"Goose".plural #=> "Geese"
To load the entire English library, including the 'lanaguage/mixin'
script, simply use:
require 'english'
See Language project for more information on support for other languages.
For details on all the methods the English library supplies see the
API documentation.
NOTE: If your system has a case insensitive file system, an alternative
to +english.rb+ is provided. Use +en.rb+ instead:
require 'en'
== INSTALLATION
Using RubyGems
$ sudo gem install english
We do not recommend site installations any longer, but if you need
to do so, you can download the .tar.gz file from GitHub and use
Ruby Setup to install
English manually:
$ tar -xvzf english-1.0.0.tar.gz
$ cd english-1.0.0
$ sudo setup.rb
For Windows users the last line needs to be 'ruby setup.rb'.
== TESTING
To run the test suite without installing, you can use:
$ script/test
== AUTHORS
Many developers, both directly and indirectly, made English possible.
See the AUTHORS file for a list of specific acknowledgements.
== COPYING
English, Copyright (c) 2006–2010 Thomas Sawyer
Some libraries within English are copyrighted to respective authors,
or are derivatives of such acknowledged work. See the library files
for copyright notices.
The English collection is distributed under the terms of the MIT license.