Permalink
Browse files

update readme and license

  • Loading branch information...
1 parent 596f146 commit b188990a1d707a2b4a37bd5813f1d0af1b0febdf @lxyu committed Aug 29, 2012
Showing with 34 additions and 13 deletions.
  1. +10 −6 LICENSE
  2. +24 −7 README.md → README.rst
View
16 LICENSE
@@ -1,9 +1,13 @@
Copyright (c) 2012, Lx Yu
-All rights reserved.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
View
@@ -6,29 +6,46 @@ Help you guess drawsomething words by brute force all permutations.
Depends
-------
-* pyenchant (for spell checking)
-* google-translate (for words translation)
+- pyenchant
+- google-translate
Install Guide
-------------
Take OS X for example.
-Enchant is a program used for spell checking.
+Drawsomething depends on enchant to do spell checking.
As pyenchant is only a python binding for enchant, we need to install enchant first. And we also need to install aspell with en dict because enchant use aspell as backend.
+::
+
$ brew install aspell --lang=en
$ brew install enchant
$ pip install pyenchant google-translate
Usage
-----
- from drawsomething import get_words
- words = get_words('esttxyz', 4)
+One line script to generate all possible words.
-Example
--------
+::
+
+ >>> import drawsomething
+ >>> drawsomething.get_words('esttxyz', 4)
+ ['ttys', 'sexy', 'yest', 'text', 'sett', 'zest', 'stet', 'test']
+
+
+The `example.py` is an simple script to list all possible words with translations.
+
+::
$ python example.py -l 4 -c esttxyz
+ ttys ttys中
+ sexy 性感
+ yest
+ text 文本
+ sett
+ zest 热情
+ stet
+ test 测试

0 comments on commit b188990

Please sign in to comment.