branch: externals/a68-mode
commit 780a0fdd2fa4ff88de69503795c2abec32cb7699
Author: Omar Polo <o...@omarpolo.com>
Commit: Omar Polo <o...@omarpolo.com>
improve README.md
---
README.md | 21 +++++++++++++++++++--
1 file changed, 19 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index b296b3d25f..6875023a5f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,21 @@
-# algol-mode
+# a68-mode -- Algol68 major mode
This is an improved and modernised version of algol68 mode by Jose
-E. Marchesi.
+E. Marchesi. It fully supports automatic indentation and font locking
+(i.e. syntax highlighting -- comments included).
+
+
+### 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`.
+
+
+### Customization
+
+The following variables are available for customization (see `M-x
+customize-group a68 RET`)
+
+ * `a68-indent-level` (default 3): indentation offset
+ * `a68-comment-style` (default `"#"`): the default comment style used
+ by e.g. `comment-dwim`.
