Skip to content

Commit d4ab181

Browse files
uberhackerlucasdemarchi
authored andcommitted
Add Requirements section and add note about installation
1 parent 623ad47 commit d4ab181

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,17 @@ Repository: <https://github.com/lucasdemarchi/codespell>
1717

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

20+
Requirements
21+
------------
22+
23+
Python 3.0 or above.
24+
2025
Usage
2126
-----
2227

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

0 commit comments

Comments
 (0)