[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] new-master 226da6a 007/128: Added script and documentation for in
From: |
Stefan Monnier |
Subject: |
[elpa] new-master 226da6a 007/128: Added script and documentation for installing from CVS |
Date: |
Mon, 14 Dec 2020 15:39:20 -0500 (EST) |
branch: new-master
commit 226da6a21b78f5d6cc54369e4a915b5fc580b33b
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
- viritrilbia@users.sourceforge.net.
+ <http://sourceforge.net/tracker/?group_id=8658&atid=108658>, or
+ through email to <viritrilbia@users.sourceforge.net>.
CONTACT INFO
- MMM Mode is written and maintained by Michael Abraham Shulman
- <viritrilbia@users.sourceforge.net>.
+ MMM Mode is written and maintained by Michael Shulman,
+ <viritrilbia@users.sourceforge.net>, and others; a list of some
+ contributors can be found on the Sourceforge project.
MAILING LIST
- [elpa] branch new-master created (now 61bd755), Stefan Monnier, 2020/12/14
- [elpa] new-master a1502c2 008/128: Track original positions in the face of possible edits. Intended use in debugging where one might edit the file but continue editing., Stefan Monnier, 2020/12/14
- [elpa] new-master 989f788 006/128: Added comment about installing with multiple emacsen., Stefan Monnier, 2020/12/14
- [elpa] new-master e33caa0 011/128: * html/index.html, html/layout.css : Initial import., Stefan Monnier, 2020/12/14
- [elpa] new-master 226da6a 007/128: Added script and documentation for installing from CVS,
Stefan Monnier <=
- [elpa] new-master d14b47a 010/128: * COPYING, ChangeLog, README, admin/org-synch.el,, Stefan Monnier, 2020/12/14
- [elpa] new-master 385d3ec 012/128: * README: Explain how to run the repo build script., Stefan Monnier, 2020/12/14
- [elpa] new-master b83d412 013/128: README: Document usage of this repository in detail., Stefan Monnier, 2020/12/14
- [elpa] new-master 3ec9dc4 002/128: # Added comment about loading supplied classes separately., Stefan Monnier, 2020/12/14
- [elpa] new-master 7a4e787 016/128: Update README to describe the new repository layout., Stefan Monnier, 2020/12/14
- [elpa] new-master f232d97 017/128: Add full licence text (COPYING), Stefan Monnier, 2020/12/14
- [elpa] new-master 54a4cb6 018/128: Initial checkin of files. These files were initially part of the, Stefan Monnier, 2020/12/14
- [elpa] new-master c1b76ff 019/128: Rework test-unit into something even simpler., Stefan Monnier, 2020/12/14
- [elpa] new-master fd0dc42 024/128: Initial Import, Stefan Monnier, 2020/12/14
- [elpa] new-master feebdea 029/128: README.md, load-relative.el: Go over documentation. Makefile.am: add targets test and test-short, Stefan Monnier, 2020/12/14
- Prev by Date:
[elpa] new-master e33caa0 011/128: * html/index.html, html/layout.css : Initial import.
- Next by Date:
[elpa] new-master d14b47a 010/128: * COPYING, ChangeLog, README, admin/org-synch.el,
- Previous by thread:
[elpa] new-master e33caa0 011/128: * html/index.html, html/layout.css : Initial import.
- Next by thread:
[elpa] new-master d14b47a 010/128: * COPYING, ChangeLog, README, admin/org-synch.el,
- Index(es):