diff options
Diffstat (limited to 'tools/editors/emacs/README.txt')
| -rw-r--r-- | tools/editors/emacs/README.txt | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/tools/editors/emacs/README.txt b/tools/editors/emacs/README.txt new file mode 100644 index 000000000..2c3e32ce5 --- /dev/null +++ b/tools/editors/emacs/README.txt @@ -0,0 +1,29 @@ +.. -*- coding: utf-8 -*- + +===================== + Emacs Support Files +===================== + +:Date: $Date$ + +This directory contains the following Emacs lisp package files: + +* rst.el: Emacs support for reStructuredText_. This file contains + + * Section decoration/adornment creation and updating (M. Blais); + * Table-of-contents mode and insertion (M. Blais); + * Font-lock syntax highlighting (S. Merten); + * Some handy editing functions (D. Goodger). + * Some functions for converting documents from emacs (M. Blais). + +* tests subdirectory: automated tests for some of the features in rst.el. + Please make sure the tests pass if you change the LISP code. Just type "make" + to run the tests. + +To install the package, put a copy of the package file in a directory on your +``load-path`` (use ``C-h v load-path`` to check). + +For setup and usage details, see `Emacs Support for reStructuredText +<../../../docs/user/emacs.html>`_. + +.. _reStructuredText: http://docutils.sourceforge.net/rst.html |