README

   1
   2 This is the README file for the Emacs Muse.
   3
   4 The terms "the Emacs Muse", "Emacs Muse", and "Muse" will be used
   5 interchangeably throughout this document to refer to this software.
   6
   7 Synopsis
   8 ========
   9
  10 Emacs Muse is an authoring and publishing environment for Emacs.  It
  11 simplifies the process of writings documents and publishing them to
  12 various output formats.
  13
  14 Muse consists of two main parts: an enhanced text-mode for authoring
  15 documents and navigating within Muse projects, and a set of publishing
  16 styles for generating different kinds of output.
  17
  18 Directory contents
  19 ==================
  20
  21 The directory structure is as follows.
  22
  23 The manual (muse.texi) is in the top-level directory.
  24
  25 contrib :: Files that are not a part of Muse proper, but are useful
  26            enough to be bundled with Muse.
  27
  28 examples :: Example configuration files for use with Muse, as well as
  29             a publishable quickstart guide.
  30
  31 experimental :: Source code that is not yet considered stable.
  32
  33 lisp :: Muse source code.
  34
  35 scripts :: Scripts that are used when publishing the QuickStart
  36            document; they might prove useful if you want to automate
  37            the building of Muse documents.
  38
  39 Getting started
  40 ===============
  41
  42 Compilation
  43 -----------
  44
  45 This is an optional step, since Emacs Lisp source code does not
  46 necessarily have to be byte-compiled.  It will yield a speed increase,
  47 though.
  48
  49 A working copy of Emacs or XEmacs is needed in order to compile the
  50 Emacs Muse.  By default, the program that is installed with the name
  51 `emacs' will be used.
  52
  53 If you want to use the `xemacs' binary to perform the compilation, you
  54 would need to edit `Makefile.defs' in the top-level directory as
  55 follows.  You can put either a full path to an Emacs or XEmacs binary
  56 or just the command name, as long as it is in the PATH.
  57
  58 EMACS    = xemacs
  59 SITEFLAG = -no-site-file
  60
  61 Running `make' should compile the Muse source files in the `lisp'
  62 directory.
  63
  64 Installation
  65 ------------
  66
  67 Muse may be installed into your file hierarchy by doing the following.
  68
  69 Edit the `Makefile.defs' file so that ELISPDIR points to where you
  70 want the source and compiled Muse files to be installed and INFODIR
  71 indicates where to put the Muse manual.  Of course, you will want to
  72 edit EMACS and SITEFLAG as shown in the Compilation section if you are
  73 using XEmacs.
  74
  75 Run `make' as a normal user.
  76
  77 Run `make install' as the root user if you have chosen installation
  78 locations that require this.
  79
  80 Insinuation
  81 -----------
  82
  83 Two things need to happen in order for Muse to be usable with your
  84 version of Emacs or XEmacs.
  85
  86  1. The location of the Muse directory needs to be added to the load
  87     path so that your variant of Emacs can find it.
  88
  89  2. You need to load whichever Muse files you wish to make use of.
  90
  91 A quick example that accomplishes both of these follows.
  92
  93 ;; Add this to your .emacs or .xemacs/init.el file.
  94 (setq load-path (add-to-list 'load-path "/path/to/muse"))
  95 (require 'muse-mode)
  96
  97 Documentation
  98 -------------
  99
 100 The Muse manual may be generated by running `make doc'.
 101
 102 It will produce two files: an Info file called `muse.info' and an HTML
 103 document called `muse.html'.
 104
 105 This manual is also available online in several forms.
 106
 107  - PDF: http://www.mwolson.org/static/doc/muse.pdf
 108  - HTML (single file): http://www.mwolson.org/static/doc/muse.html
 109  - HTML (multiple files): http://www.mwolson.org/static/doc/muse/
 110
 111 QuickStart
 112 ----------
 113
 114 Type "make examples" to generate a quickstart guide for Muse.  An HTML
 115 document called QuickStart.html, an Info document called
 116 QuickStart.info, and a PDF file called QuickStart.pdf will be created
 117 in the `examples' directory.
 118
 119 If you do not have a working LaTeX installation with the proper fonts,
 120 the PDF file will not be successfully generated.
 121
 122 To see the document that is interpreted in order to generate these
 123 files, take a look at `examples/QuickStart'.
 124
 125 To view the generated Info document from within Emacs, try the
 126 following.
 127
 128 C-u M-x info RET /path/to/muse/examples/QuickStart.info RET
 129
 130 Further Documentation
 131 =====================
 132
 133 Please consult http://www.emacswiki.org/cgi-bin/wiki/MuseMode to find
 134 more information on bugs, unimplemented features, and user-contributed
 135 tweaks.
 136
 137 The current maintainer's website is at
 138 http://www.mwolson.org/projects/MuseMode.html.
 139
 140 A mailing list for Muse and some related software exists; consult
 141 http://www.emacswiki.org/cgi-bin/wiki/EmacsWikiMailingList for details
 142 on joining it or viewing its contents.