summaryrefslogtreecommitdiffstats
path: root/development/codespell/README
diff options
context:
space:
mode:
Diffstat (limited to 'development/codespell/README')
-rw-r--r--development/codespell/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/development/codespell/README b/development/codespell/README
new file mode 100644
index 0000000000..6c714b66f2
--- /dev/null
+++ b/development/codespell/README
@@ -0,0 +1,9 @@
+codespell (spell checker for source code)
+
+codespell fixes 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.
+
+Optional dependency: python-chardet. This is required for codespell's
+-e option. Unless you deal with files that are not ASCII, ISO-8859-1,
+or UTF-8, you probably don't need the -e option.