branch: elpa/forth-mode
commit d47662b187b8615c1b0ca491611f46a4f1838104
Author: Lars Brinkhoff <[email protected]>
Commit: Lars Brinkhoff <[email protected]>
Add some installation and usage instrutions.
---
README.md | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/README.md b/README.md
index a8e6661f9a..41fa51c259 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,26 @@ Planned:
- Tab completion.
- Query a running Forth about words, search order, etc.
+
+### Installation
+
+MELPA:
+
+ M-x package-install forth-mode
+
+Manual:
+
+ git clone http://github.com/larsbrinkhoff/forth-mode DIR
+
+ # Add to .emacs
+ (pushnew "DIR" load-path)
+ (require 'forth-mode)
+ (require 'forth-block-mode)
+ (require 'forth-interacton-mode)
+
+### Usage
+
+To enable Forth major mode, type `M-x forth-mode`. The file
+extensions `.f`, `.fs`, and `.fth` are recognised automatically.
+
+To start an interactive Forth session, type `M-x run-forth`.
