From 8339cb59312b0e4519e2deabb463ff9eef2579a5 Mon Sep 17 00:00:00 2001 From: Eric Larson Date: Thu, 9 Jun 2016 14:09:58 -0400 Subject: [PATCH] FIX: Fix readme --- Makefile | 3 +++ README.md => README.rst | 52 ++++++++++++++++++++----------------- codespell_lib/_codespell.py | 2 +- setup.py | 2 +- 4 files changed, 33 insertions(+), 26 deletions(-) rename README.md => README.rst (58%) diff --git a/Makefile b/Makefile index 32505ae4f0..b541dc91ec 100644 --- a/Makefile +++ b/Makefile @@ -60,6 +60,9 @@ tar-sync: codespell-$(VERSION).tar.xz codespell-$(VERSION).tar.xz.asc --name codespell-$(VERSION).tar.xz.asc \ --file codespell-$(VERSION).tar.xz.asc +pypi: + python setup.py sdist register upload + clean: rm -rf codespell rm -rf codespell.1 diff --git a/README.md b/README.rst similarity index 58% rename from README.md rename to README.rst index ada21c8a82..46a03358a9 100644 --- a/README.md +++ b/README.rst @@ -4,30 +4,34 @@ codespell Fix common misspellings in text files. It's designed primarily for checking misspelled words in source code, but it can be used with other files as well. -Information ------------ - -GitHub project: +Useful links +------------ -Mailing list: with web archives/interface at - +* `GitHub project `_ +* Mailing list: with web archives/interface + `here `_ -Repository: +* `Repository `_ -Releases: +* `Releases `_ Requirements ------------ -Python 3.0 or above. +Python 2.7 or above. + +Installation +------------ + +You can use ``pip`` to install codespell with e.g.:: -make and help2man packages needed for "make install". + pip install codespell Usage ----- -Check usage with `./codespell.py -h`. There are a few command line options. +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 @@ -43,31 +47,31 @@ i.e. from Wikipedia. The difference is how multiple options are treated and that the last argument is the reason why a certain entry could not be applied directly, but instead be manually inspected. E.g: -1. Simple entry: one wrong word / one suggestion +1. Simple entry: one wrong word / one suggestion:: - `calulated->calculated` + calulated->calculated -2. Entry with more than one suggested fix +2. Entry with more than one suggested fix:: - `fiel->feel, field, file, phial,` + fiel->feel, field, file, phial, - Note the last comma! You need to use it, otherwise the last suggestion -will be discarded (see below for why). When there are more than one -suggestion, automatically fix is not possible and the best we can do is -to give the user the file and line where the error occurred as well as -the suggestions. + Note the last comma! You need to use it, otherwise the last suggestion + will be discarded (see below for why). When there are more than one + suggestion, automatically fix is not possible and the best we can do is + to give the user the file and line where the error occurred as well as + the suggestions. -3. Entry with one word, but with automatically fix disabled +3. Entry with one word, but with automatically fix disabled:: - `clas->class, disabled because of name clash in c++` + clas->class, disabled because of name clash in c++ Note that there isn't a comma in the end of the line. The last argument is -treated as the reason why a suggestion cannot be automatically applied. + treated as the reason why a suggestion cannot be automatically applied. License ------- -The Python script `codespell.py` is available with the following terms: +The Python script ``codespell.py`` is available with the following terms: (*tl;dr*: [GPL v2][]) > Copyright (C) 2010-2011 Lucas De Marchi diff --git a/codespell_lib/_codespell.py b/codespell_lib/_codespell.py index b4d5080aa5..71a91015c4 100755 --- a/codespell_lib/_codespell.py +++ b/codespell_lib/_codespell.py @@ -30,7 +30,7 @@ USAGE = """ \t%prog [OPTIONS] [file1 file2 ... fileN] """ -VERSION = '1.9' +VERSION = '1.9.0' misspellings = {} exclude_lines = set() diff --git a/setup.py b/setup.py index a5515d05f5..5619389a75 100755 --- a/setup.py +++ b/setup.py @@ -20,7 +20,7 @@ URL = 'https://github.com/lucasdemarchi/codespell/' LICENSE = 'GPL v2' DOWNLOAD_URL = 'https://github.com/lucasdemarchi/codespell/' -with open('README.md', 'r') as f: +with open('README.rst', 'r') as f: LONG_DESCRIPTION = f.read() if __name__ == "__main__":