branch: elpa-admin
commit 6ee3dad0d7647eadbdce4b11760b8bf3d8b0c333
Author: viritrilbia <viritrilbia>
Commit: viritrilbia <viritrilbia>
Added script and documentation for installing from CVS
---
README | 76 ++++++++++++++++++++++++++++++++++++++++++++++--------------------
1 file changed, 53 insertions(+), 23 deletions(-)
diff --git a/README b/README
index eb45686..fdcb874 100644
--- a/README
+++ b/README
@@ -5,16 +5,19 @@
OVERVIEW
MMM Mode is a minor mode for Emacs that allows Multiple Major Modes
- (hence the name) to coexist in one buffer. It is particularly
- well-suited to editing embedded code, such as Mason server-side
- Perl, or HTML output in CGI scripts.
+ to coexist in one buffer. It is well-suited to editing:
+
+ * Preprocessed code, such as server-side Perl or PHP embedded in HTML
+ * Code generating code, such as HTML output by CGI scripts
+ * Embedded code, such as Javascript in HTML
+ * Literate programming: code interspersed with documentation, e.g. Noweb
INSTALLATION
MMM Mode has a standard GNU configure-driven installation. (See the
- file INSTALL for generic instructions.) To install mmm-mode in the
- standard locations, unpack the archive, `cd' to the mmm-mode-X.X.X
- directory created, and run these commands:
+ file INSTALL for generic instructions, most of which don't apply.)
+ To install in the standard locations, unpack the archive, `cd' to
+ the mmm-mode-X.X.X directory created, and run these commands:
./configure
make
@@ -27,6 +30,12 @@ INSTALLATION
installs the MMM Mode info manual in your site info directory, so if
you're installing manually, you might want to do that too.
+ If you're installing from the CVS version, you won't have the
+ configure script. If you have the automake/autoconf tools
+ installed, you can run the script `autogen.sh' first, and then
+ proceed as above. Otherwise, you'll have to copy the *.el files
+ manually as described above.
+
If you have more than one version of emacs installed and want to
use MMM in a version other than /usr/bin/emacs, you must set the
environment variable EMACS before running `configure', e.g.
@@ -44,43 +53,64 @@ CONFIGURATION
Once MMM Mode is installed, it has to be configured correctly. This
can be done in a site-start file or in user's initialization files;
- probably the latter is preferable, except possibly for autoloads.
-
- See the info file for full documentation on the available
- configuration options. To get started, however, MMM Mode needs to
- be loaded, either completely, with
+ usually the latter is preferable, except possibly for autoloads.
+ First the package needs to be loaded, with either
(require 'mmm-mode)
- or conditionally, as necessary, with
+ or instead, to save time during emacs startup,
(require 'mmm-auto)
- The second installs only the major-mode hooks and sets up MMM Mode
- to load itself automatically when necessary.
+ Then you will probably want to set something like this:
+
+ (setq mmm-global-mode 'maybe)
+ (mmm-add-mode-ext-class 'html-mode "\\.php\\'" 'html-php)
+
+ The first line tells MMM Mode to load itself whenever you open an
+ appropriate file, and the second is an example which says to notice
+ PHP regions in html-mode files having a `.php' extension. Both
+ lines are necessary.
+
+ You will, of course, want to change and duplicate the second line
+ according to your needs. either of the first two parameters can be
+ `nil', meaning not to consider that criterion. For example, if all
+ your html files, regardless of extension, are Mason components, you
+ will want something like:
+
+ (mmm-add-mode-ext-class 'html-mode nil 'mason)
+
+ whereas if all your files with a `.nw' extension, regardless of
+ primary mode (some may be LaTeX, others HTML, say) are Noweb, you
+ will prefer
+
+ (mmm-add-mode-ext-class nil "\\.nw\\'" 'noweb)
+
+ See the info file for more extensive documentation, and for other
+ configuration options.
DOCUMENTATION
- For further information, see (in order) the accompanying info file
- (as yet incomplete), the documentation strings of functions and
- variables, the comments in the source code, and the source code
- itself.
+ For further information, see (in order) the accompanying info file,
+ the documentation strings of functions and variables, the comments
+ in the source code, and the source code itself.
UPDATES
The latest version of MMM Mode should always be available from
- http://mmm-mode.sourceforge.net/.
+ http://sourceforge.net/projects/mmm-mode
BUG REPORTS
Bug reports and suggestions can be submitted at
- <http://sourceforge.net/bugs/?group_id=8658> or through email to
- viritril...@users.sourceforge.net.
+ <http://sourceforge.net/tracker/?group_id=8658&atid=108658>, or
+ through email to <viritril...@users.sourceforge.net>.
CONTACT INFO
- MMM Mode is written and maintained by Michael Abraham Shulman
- <viritril...@users.sourceforge.net>.
+ MMM Mode is written and maintained by Michael Shulman,
+ <viritril...@users.sourceforge.net>, and others; a list of some
+ contributors can be found on the Sourceforge project.
MAILING LIST
