Skip to content

Commit

Permalink
Add Requirements section and add note about installation
Browse files Browse the repository at this point in the history
  • Loading branch information
uberhacker authored and lucasdemarchi committed Jun 18, 2015
1 parent 623ad47 commit d4ab181
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,17 @@ Repository: <https://github.com/lucasdemarchi/codespell>

Releases: <https://github.com/lucasdemarchi/codespell/releases>

Requirements
------------

Python 3.0 or above.

Usage
-----

Check usage with `./codespell -h`. There are a few command line options. We ship
a dictionary that is an improved version of the one available at
Check usage with `./codespell.py -h`. There are a few command line options.
Note that upon installation with "make install" we don't have the "py" suffix.
We ship a dictionary that is an improved version of the one available at
<http://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings/For_machines>
after applying them in projects like Linux Kernel, EFL, oFono among others.
You can provide your own version of the directory, but patches for
Expand Down

0 comments on commit d4ab181

Please sign in to comment.