Browse Source

Added README file.

Paul Onions 10 years ago
parent
commit
5458d0b5c1
1 changed files with 43 additions and 0 deletions
  1. 43 0
      README

+ 43 - 0
README

@@ -0,0 +1,43 @@
+RPL-TOOLS
+=========
+
+Useful tools for working with RPL source code, the native language of
+HP48/49/50-series calculators.
+
+In its present state really only provides `sysrpl-mode' for editing
+SysRPL source files.  This mode implements syntax highlighting and
+documentation lookup, using data extracted from Carsten Dominik's
+``entries.db'' system RPL entries database.
+
+To install rpl-tools, clone the Mercurial repository to somewhere in
+your Emac's `load-path' with
+
+  hg clone http://bitbucket.org/pdo/rpl-tools
+
+then add the following to your ~/.emacs file
+
+  (require 'rpl-tools)
+  (add-to-list 'sysrpl-mode-hook 'eldoc-mode)
+
+where the latter command activates the minor eldoc-mode in
+sysrpl-mode.  This causes a stack-effect diagram to be displayed in
+the minibuffer, corresponding to the SysRPL word under the cursor.
+
+More info can be displayed with the `sysrpl-apropos-thing-at-point'
+command, bound to C-c C-a by default, which pops up another window
+with any extra information available for the supplied word (by default
+the one under the cursor).
+
+Note: sysrpl-mode is not bound to any particular file extension by
+default, so to enable it you will have to issue the command
+
+  M-x sysrpl-mode
+
+to place the current buffer into sysrpl-mode.  This can of course be
+automated by adding an appropriate rule to the 'auto-mode-alist'
+variable in your ~/.emacs file.
+
+--
+Paul Onions
+24 May 2014
+paul.onions@acm.org