~ubuntu-branches/ubuntu/precise/muse-el/precise

« back to all changes in this revision

Viewing changes to README

  • Committer: Bazaar Package Importer
  • Author(s): Michael W. Olson (GNU address)
  • Date: 2007-06-25 08:17:44 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070625081744-h9xfz7c72h1pfyo6
Tags: 3.03-1ubuntu1
* Closes LP: #123907
* Sync with Debian.  Remaining changes:
  - Keep (add) manual.
* debian/control:
  - Set Ubuntu MOTU to be Maintainer and myself as
    XSBC-Original-Maintainer to silence warning.
* debian/rules;
  - Manual is now in texi/ directory.
  - Clean generated html files and info file for the manual.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
 
2
 
This is the README file for the Emacs Muse.
3
 
 
4
 
The terms "the Emacs Muse", "Emacs Muse", and "Muse" are used
5
 
interchangeably throughout this document to refer to this software.
 
1
                                                          -*- Text -*-
 
2
This is the README file for Emacs Muse.
 
3
 
 
4
The terms "Emacs Muse", and "Muse" are used interchangeably throughout
 
5
this document to refer to this software.
6
6
 
7
7
Synopsis
8
8
========
15
15
authoring documents and navigating within Muse projects, and a set of
16
16
publishing styles for generating different kinds of output.
17
17
 
18
 
License
19
 
=======
20
 
 
21
 
Emacs Muse is free software; you can redistribute it and/or modify it
22
 
under the terms of the GNU General Public License as published by the
23
 
Free Software Foundation; either version 2, or (at your option) any
24
 
later version.
25
 
 
26
 
Emacs Muse is distributed in the hope that it will be useful, but
27
 
WITHOUT ANY WARRANTY; without even the implied warranty of
28
 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
29
 
General Public License for more details.
30
 
 
31
 
You should have received a copy of the GNU General Public License
32
 
along with Emacs Muse; see the file COPYING.  If not, write to the
33
 
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
34
 
Boston, MA 02110-1301, USA.
35
 
 
36
18
Directory contents
37
19
==================
38
20
 
39
21
The directory structure is as follows.
40
22
 
41
 
The manual (muse.texi) is in the top-level directory.
 
23
etc :: Miscellaneous files like the emacs-wiki migration guide, the
 
24
  list of ideas for the future, and a RelaxNG schema for Muse XML.
42
25
 
43
26
contrib :: Files that are not a part of Muse proper, but are useful
44
 
           enough to be bundled with Muse.
 
27
  enough to be bundled with Muse.
45
28
 
46
29
examples :: Example configuration files for use with Muse, a
47
 
            publishable quickstart guide, and miscellaneous helper
48
 
            stuff.
 
30
  publishable quickstart guide, and miscellaneous helper stuff.
49
31
 
50
32
experimental :: Source code that is not yet considered stable.
51
33
 
52
34
lisp :: Muse source code.
53
35
 
54
36
scripts :: Scripts that are used when compiling Muse and publishing
55
 
           the QuickStart document; they might prove useful if you
56
 
           want to automate the building of Muse documents.
 
37
  the QuickStart document; they might prove useful if you want to
 
38
  automate the building of Muse documents.
 
39
 
 
40
texi :: The manual (muse.texi) and any supplemental sections.
57
41
 
58
42
Getting started
59
43
===============
60
44
 
 
45
Prerequisites
 
46
-------------
 
47
 
 
48
You need either Emacs (21.1 or greater), XEmacs (21.4 or greater), or
 
49
SXEmacs (warning: Muse has not been tested with SXEmacs).  The current
 
50
maintainer recommend using Emacs.
 
51
 
61
52
Compilation
62
53
-----------
63
54
 
91
82
edit EMACS and SITEFLAG as shown in the Compilation section if you are
92
83
using XEmacs.
93
84
 
94
 
If you are installing Muse on a Debian system, you might want to
95
 
change the value of INSTALLINFO as specified in `Makefile.defs'.
 
85
If you are installing Muse on a Debian or Ubuntu system, you might
 
86
want to change the value of INSTALLINFO as specified in
 
87
`Makefile.defs'.
96
88
 
97
89
If you wish to install Muse to different locations than the defaults
98
90
specify, edit `Makefile.defs' accordingly.
118
110
;; Add this to your .emacs or .xemacs/init.el file.
119
111
(setq load-path (add-to-list 'load-path "/path/to/muse"))
120
112
(require 'muse-mode)
 
113
(require 'muse-publish)
 
114
(require 'muse-html)  ;; and so on
121
115
 
122
116
Documentation
123
117
-------------
125
119
The Muse manual may be generated by running `make doc'.
126
120
 
127
121
It will produce two files: an Info file called `muse.info' and an HTML
128
 
document called `muse.html'.
 
122
document called `muse.html'.  Both of these will be created in the
 
123
`texi' directory.
129
124
 
130
125
This manual is also available online in several forms.
131
126
 
155
150
Further Documentation
156
151
=====================
157
152
 
158
 
Please consult http://www.emacswiki.org/cgi-bin/wiki/MuseMode to find
 
153
Please consult http://www.emacswiki.org/cgi-bin/wiki/EmacsMuse to find
159
154
more information on bugs, unimplemented features, and user-contributed
160
155
tweaks.
161
156
 
162
 
The current maintainer's website is at
 
157
The current maintainer's webpage for Muse is at
163
158
http://www.mwolson.org/projects/EmacsMuse.html.
164
159
 
165
 
A mailing list for Muse and some related software exists; consult
166
 
http://www.emacswiki.org/cgi-bin/wiki/EmacsWikiMailingList for details
167
 
on joining it or viewing its contents.
 
160
Mailing Lists
 
161
=============
 
162
 
 
163
Mailing lists for Muse exist.
 
164
 
 
165
muse-el-announce ::
 
166
  Low-traffic list for Muse-related announcements.
 
167
 
 
168
  You can join this mailing list (muse-el-announce@gna.org)
 
169
  using the subscription form at
 
170
  http://mail.gna.org/listinfo/muse-el-announce/.
 
171
 
 
172
  This mailing list is also available via Gmane (http://gmane.org/).
 
173
  The group is called
 
174
  gmane.emacs.muse.announce.
 
175
 
 
176
muse-el-discuss ::
 
177
  Discussion, bugfixes, suggestions, tips, and the like for Muse.
 
178
  This mailing list also includes the content of muse-el-announce.
 
179
 
 
180
  You can join this mailing list (muse-el-discuss@gna.org)
 
181
  using the subscription form at
 
182
  http://mail.gna.org/listinfo/muse-el-discuss/.
 
183
 
 
184
  This mailing list is also available via Gmane with the identifier
 
185
  gmane.emacs.muse.general.
 
186
 
 
187
muse-el-logs ::
 
188
  Log messages for commits made to Muse.
 
189
 
 
190
  You can join this mailing list (muse-el-logs@gna.org) using
 
191
  the subscription form at
 
192
  http://mail.gna.org/listinfo/muse-el-logs/.
 
193
 
 
194
  This mailing list is also available via Gmane with the identifier
 
195
  gmane.emacs.muse.scm.
 
196
 
 
197
muse-el-commits ::
 
198
  Generated bug reports for Emacs Muse.  If you use our bug-tracker at
 
199
  https://gna.org/bugs/?group=muse-el, the bug reports will be sent to
 
200
  this list automatically.
 
201
 
 
202
  You can join this mailing list (muse-el-commits@gna.org) using
 
203
  the subscription form at
 
204
  http://mail.gna.org/listinfo/muse-el-commits/.
 
205
 
 
206
  This mailing list is also available via Gmane with the identifier
 
207
  gmane.emacs.muse.cvs.
 
208
 
 
209
License
 
210
=======
 
211
 
 
212
Emacs Muse is free software; you can redistribute it and/or modify it
 
213
under the terms of the GNU General Public License as published by the
 
214
Free Software Foundation; either version 2, or (at your option) any
 
215
later version.
 
216
 
 
217
Emacs Muse is distributed in the hope that it will be useful, but
 
218
WITHOUT ANY WARRANTY; without even the implied warranty of
 
219
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
220
General Public License for more details.
 
221
 
 
222
You should have received a copy of the GNU General Public License
 
223
along with Emacs Muse; see the file COPYING.  If not, write to the
 
224
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 
225
Boston, MA 02110-1301, USA.
 
226
 
 
227
The Muse manual is available under the terms of the GNU Free
 
228
Documentation License, Version 1.2 or any later version published by
 
229
the Free Software Foundation; with no Invariant Sections, and with the
 
230
Front-Cover texts and Back-Cover Texts as specified in the manual.  A
 
231
copy of the license is included in the section entitled "GNU Free
 
232
Documentation License" in the Muse manual.  All Emacs Lisp code
 
233
contained in the manual may be used, distributed, and modified without
 
234
restriction.
 
235
 
 
236
The PNG images included in the examples/ directory may be used,
 
237
distributed, and modified without restriction.