commit 780a0fdd2fa4ff88de69503795c2abec32cb7699
from: Omar Polo <op@omarpolo.com>
date: Sun Nov 07 18:53:39 2021 UTC

improve README.md

commit - 18be0e1315988338e68f9ff5df9e8184ea1b77b6
commit + 780a0fdd2fa4ff88de69503795c2abec32cb7699
blob - b296b3d25f59f37b91fb20c077b9fa6cffe570cf
blob + 6875023a5f38cb9ba016d9fb1450c8b87379a2b8
--- README.md
+++ 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`.