[elpa] externals/relint 0f76132 40/44: Add README.org

[Mattias Engdegård]

branch: externals/relint
commit 0f7613211ccdd6340caed1fe0ba5aa8789f2b75b
Author: Mattias Engdegård <address@hidden>
Commit: Mattias Engdegård <address@hidden>

    Add README.org
---
 README.org | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..2ce02db
--- /dev/null
+++ b/README.org
@@ -0,0 +1,39 @@
+#+TITLE: relint.el
+
+Relint (regular expression lint) scans elisp files for mistakes in
+regexps, including deprecated syntax and bad practice. It also checks
+the regexp-like arguments to ~skip-chars-forward~ and
+~skip-chars-backward~.
+
+* Usage
+
+Check a single file:
+
+: M-x relint-file
+
+Check all .el files in a directory tree:
+
+: M-x relint-directory
+
+From batch mode:
+
+: emacs -batch -l relint.el -f relint-batch FILES-AND-DIRS...
+
+where directories are scanned recursively.
+
+* Installation
+
+Download the source file =relint.el= and set ~load-path~:
+
+: (add-to-list 'load-path "RELINT-DIRECTORY")
+
+Relint requires the package [[https://elpa.gnu.org/packages/xr.html][xr]]; 
install it from GNU ELPA.
+
+* Bugs
+
+The recognition of regexps is done by ad-hoc rules; the simplistic
+method employed means that many errors will go undetected.
+
+Still, if you believe that a flawed regexp could have been discovered
+but wasn't, please report it as a bug. Reports of false positives and
+crashes are of course equally welcome.