branch: elpa-admin
commit da5ff0a8c54b175f69e424591990804c81d1b784
Author: mas <mas>
Commit: mas <mas>
Added to CVS (formerly not under RCS).
---
README | 74 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 74 insertions(+)
diff --git a/README b/README
new file mode 100644
index 0000000..b990d24
--- /dev/null
+++ b/README
@@ -0,0 +1,74 @@
+
+ MMM Mode Version 0.3.8
+ ======================
+
+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.
+
+INSTALLATION
+
+ MMM Mode has a standard GNU configure-driven installation. To
+ install mmm-mode in the standard locations, unpack the archive, `cd'
+ to the mmm-X.X.X directory created, and run these commands:
+
+ ./configure
+ make
+ make install
+
+ Alternately, since currently MMM Mode is written in pure Emacs Lisp,
+ you could just copy all the *.el files in the distribution to a
+ directory in your `load-path', and optionally byte-compile them
+ manually (see the Emacs Manual). The configure installation also
+ installs the MMM Mode info manual in your site info directory, so if
+ you're installing manually, you might want to do that too.
+
+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
+
+ (require 'mmm-mode)
+
+ or conditionally, as necessary, with
+
+ (require 'mmm-auto)
+
+ The second installs only the major-mode hooks and sets up MMM Mode
+ to load itself automatically when necessary.
+
+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.
+
+UPDATES
+
+ The latest version of MMM Mode should always be available from
+ http://kurukshetra.cjb.net/elisp. Check that you have the latest
+ version before reporting a bug.
+
+REPORTING BUGS
+
+ Please report bugs to mmm-b...@kurukshetra.cjb.net. Comments,
+ questions, and suggestions are also welcome.
+
+CONTACT INFO
+
+ MMM Mode is written and maintained by Michael Abraham Shulman
+ <m...@kurukshetra.cjb.net>. Please email me if you would like to be
+ added to my very-low-volume MMM Mode mailing list. The list gets
+ announcements of new releases, and might one day turn into an actual
+ mailing list for discussion of features.
+
+ Thanks for trying MMM Mode!
