branch: externals/a68-mode
commit 7b0272edf63c3624af99587ce773b21c50137b63
Author: Jose E. Marchesi <jose.march...@oracle.com>
Commit: Jose E. Marchesi <jose.march...@oracle.com>
README.md: adapted from README
---
README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 48 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..405da7e612
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# a68-mode -- Algol68 major mode
+
+This mode fully supports automatic indentation and font locking
+(i.e. syntax highlighting) including the three comment styles.
+
+a68-mode supports only the UPPER stropping style and not the QUOTE or
+POINT style.
+
+A minor mode a68-pretty-bold-tags-mode is provided that, when active,
+makes bold tags in the buffer appear in lower case and styled
+according to the a68-bold-tag-face. This allows to show bold tags as
+underlined, or bold, or whatever other visual characteristic that can
+be configured in an Emacs face.
+
+### Manual installation
+
+Just put a68-mode.el somewhere in your load-path and require it.
+Or visit the file with Emacs and M-x package-install-file RET.
+
+### Customization
+
+The following variables are available for customization:
+
+ * a68-indent-level (default 3): indentation offset
+ * a68-comment-style (default "#"): the default comment style used
+ by e.g. comment-dwim.
+
+see M-x customize-group a68 RET for more info.
+
+### Known issues
+
+It doesn't handle well shebangs: #! is taken as the start of the
+comment up to the next #.
+
+### Little history of this code
+
+Jose E. Marchesi wrote the first version of a68-mode.el.
+
+At some point someone got a copy of a68-mode.el, renamed it to
+algol-mode.el and distributed it in github.
+
+Then Omar Polo forked algol-mode.el, renaming it back to a68-mode.el
+and distributing the result at https://git.omarpolo.com/a68-mode.git.
+
+Finally at some point Jose decided to ditch his original version and
+start using and maintain Omar's version instead.
+
+This is that copy.
