branch: externals/xr
commit 935847437133600396c7d86f16c677ad883c8c99
Author: Mattias Engdegård <matti...@acm.org>
Commit: Mattias Engdegård <matti...@acm.org>
Replace README.org with plain-text README
It is much easier to read than a .org file in plain text, and not much
worse than github's htmlised version.
---
README | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
README.org | 63 ----------------------------------------------------------
2 files changed, 67 insertions(+), 63 deletions(-)
diff --git a/README b/README
new file mode 100644
index 0000000..2533d53
--- /dev/null
+++ b/README
@@ -0,0 +1,67 @@
+ xr -- Emacs regexp parser and analyser
+ ======================================
+
+XR converts Emacs regular expressions to the structured rx form, thus
+being an inverse of rx. It can also find mistakes and questionable
+constructs inside regexp strings.
+
+It can be useful for:
+
+- Migrating existing code to rx form
+- Understanding what a regexp string really means
+- Finding errors in regexp strings
+
+It can also parse and find mistakes in skip-sets, the regexp-like
+arguments to skip-chars-forward and skip-chars-backward.
+
+The xr package can be used interactively or by other code as a library.
+
+* Example
+
+ (xr-pp "\\`\\(?:[^^]\\|\\^\\(?: \\*\\|\\[\\)\\)")
+
+ outputs
+
+ (seq bos
+ (or (not (any "^"))
+ (seq "^"
+ (or " *" "["))))
+
+* Installation
+
+ From GNU ELPA (https://elpa.gnu.org/packages/xr.html):
+
+ M-x package-install RET xr RET
+
+* Interface
+
+ Functions parsing regexp strings:
+
+ xr -- convert regexp to rx
+ xr-pp -- convert regexp to rx and pretty-print
+ xr-lint -- find mistakes in regexp
+
+ Functions parsing skip sets:
+
+ xr-skip-set -- convert skip-set to rx
+ xr-skip-set-pp -- convert skip-set to rx and pretty-print
+ xr-skip-set-lint -- find mistakes in skip-set
+
+ Utility:
+
+ xr-pp-rx-to-str -- pretty-print rx expression to string
+
+* See also
+
+ The relint package (https://elpa.gnu.org/packages/relint.html) uses xr
+ to find regexp mistakes in elisp code.
+
+ The lex package (https://elpa.gnu.org/packages/lex.html), a lexical
+ analyser generator, provides the lex-parse-re function which
+ translates regexps to rx, but does not attempt to handle all the
+ edge cases of Elisp's regexp syntax or pretty-print the result.
+
+ The pcre2el package (https://github.com/joddie/pcre2el), a regexp
+ syntax converter and interactive regexp explainer, can also be used
+ for translating regexps to rx. However, xr is more accurate for this
+ purpose.
diff --git a/README.org b/README.org
deleted file mode 100644
index 5e06d0b..0000000
--- a/README.org
+++ /dev/null
@@ -1,63 +0,0 @@
-#+TITLE: xr.el
-
-XR converts Emacs regular expressions to the structured rx form, thus
-being an inverse of ~rx~. It can also find mistakes and questionable
-constructs inside regexp strings.
-
-It can be useful for:
-- Migrating existing code to rx form
-- Understanding what a regexp string really means
-- Finding errors in regexp strings
-
-It can also parse and find mistakes in skip-sets, the regexp-like
-arguments to ~skip-chars-forward~ and ~skip-chars-backward~.
-
-The xr package can be used interactively or by other code as a library.
-
-* Example
-
-: (xr-pp "\\`\\(?:[^^]\\|\\^\\(?: \\*\\|\\[\\)\\)")
-
-outputs
-
-: (seq bos
-: (or (not (any "^"))
-: (seq "^"
-: (or " *" "["))))
-
-* Installation
-
-From [[https://elpa.gnu.org/packages/xr.html][GNU ELPA]]:
-
-: M-x package-install RET xr RET
-
-* Interface
-
-Functions parsing regexp strings:
-
-| ~xr~ | convert regexp to rx |
-| ~xr-pp~ | convert regexp to rx and pretty-print |
-| ~xr-lint~ | find mistakes in regexp |
-
-Functions parsing skip sets:
-
-| ~xr-skip-set~ | convert skip-set to rx |
-| ~xr-skip-set-pp~ | convert skip-set to rx and pretty-print |
-| ~xr-skip-set-lint~ | find mistakes in skip-set |
-
-Utility:
-
-| ~xr-pp-rx-to-str~ | pretty-print rx expression to string |
-
-* See also
-
-The [[https://elpa.gnu.org/packages/relint.html][relint]] package uses xr to
find regexp mistakes in elisp code.
-
-The [[https://elpa.gnu.org/packages/lex.html][lex]] package, a lexical
analyser generator, provides the
-~lex-parse-re~ function which translates regexps to rx, but does not
-attempt to handle all the edge cases of Elisp's regexp syntax or
-pretty-print the result.
-
-The [[https://github.com/joddie/pcre2el][pcre2el]] package, a regexp syntax
converter and interactive regexp
-explainer, can also be used for translating regexps to rx. However, xr
-is more accurate for this purpose.
