branch: externals/relint
commit 4b78e144230cd44b072bcb44ba911d0d01e4b21b
Author: Mattias Engdegård <matti...@acm.org>
Commit: Mattias Engdegård <matti...@acm.org>
Add table of contents to README, and some advice
---
README | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/README b/README
index 0f042ad..5a987a2 100644
--- a/README
+++ b/README
@@ -6,6 +6,16 @@ syntax and bad practice. It also checks the regexp-like
arguments to
skip-chars-forward, skip-chars-backward, skip-syntax-forward and
skip-syntax-backward.
+* Contents
+
+ - Usage
+ - Installation
+ - What the diagnostics mean
+ - Suppressing diagnostics
+ - How it works
+ - Bugs
+
+
* Usage
- Check a single file:
@@ -49,6 +59,9 @@ skip-syntax-backward.
* What the diagnostics mean
+ Tip: if a regexp string is difficult to understand, consider
+ decoding it using 'xr', as in (xr-lint "gibberish").
+
- Unescaped literal 'X'
A special character is taken literally because it occurs in a
