]> granicus.if.org Git - neomutt/commitdiff
add some neomutt docs
authorRichard Russon <rich@flatcap.org>
Fri, 25 Mar 2016 18:30:01 +0000 (18:30 +0000)
committerRichard Russon <rich@flatcap.org>
Mon, 4 Apr 2016 15:38:39 +0000 (16:38 +0100)
README
README.mutt [new file with mode: 0644]
doc/manual.xml.head
doc/mutt.css

diff --git a/README b/README
index 70ef0c23d199c6fea6ccee588806a2b7fd6392d6..fa1adbe9d25aa5b659ad475296bc2fb6b44cbe41 100644 (file)
--- a/README
+++ b/README
@@ -1,28 +1,48 @@
-README for mutt-1.5
-===================
+# This is the NeoMutt Project
 
-When updating mutt from an earlier release or from Mercurial, please
-make sure to read the compatibility notes in ``UPDATING''. Older changes
-between mutt-1.2 and mutt-1.4 are listed in NEWS.
+## What is NeoMutt?
 
-If you got the mutt source code from the public Mercurial repository
-(http://dev.mutt.org/hg/mutt/), please read doc/devel-notes.txt to make
-sure that you have a complete development environment.
+NeoMutt is a project of projects.
 
-Installation instructions are detailed in ``INSTALL''. The user manual
-is in doc/manual.txt. PGP users should read doc/PGP-Notes.txt.
+A place to gather all the patches against Mutt.
 
-Before you start hacking on mutt, read doc/devel-notes.txt.  Before
-applying patches to mutt, read doc/applying-patches.txt.  Please,
-read these files, as they will save you from asking FAQs.
+A place for all the developers to gather.  Especially those who have made
+changes to Mutt, but haven't had those changes accepted.
 
-For more information, see the Mutt home page:
+Hopefully this will build the community and reduce duplicated effort.
 
- http://www.mutt.org/
+## Where is NeoMutt?
 
-The primary distribution points for Mutt is:
+  Source Code:     https://github.com/neomutt/neomutt
+  Releases:        https://github.com/neomutt/neomutt/releases/latest
+  Wiki:            https://github.com/neomutt/neomutt/wiki
+  Questions/Bugs:  https://github.com/neomutt/neomutt/issues
+  Development:     https://github.com/neomutt/neomutt/wiki/Development
 
- ftp://ftp.mutt.org/pub/mutt
+## Credits
+
+Richard Russon put a lot of work into creating NeoMutt: bringing together,
+tidying up and fixing bugs.  However, without the original patch authors, there
+would be nothing.
+
+So, a BIG thanks to...
+
+  Aaron Schrab        Jan Synacek           Rocco Rutte
+  Alain Penders       Jason DeTiberus       Roland Rosenfeld
+  Benjamin Kuperman   Jeremiah Foster       Sami Farin
+  Cedric Duval        Jeremy Katz           Stefan Assmann
+  Chris Mason         Josh Poimboeuf        Stefan Kuhn
+  Christian Aichinge  Julius Plenz          Stefan Kuhn
+  Christoph Berg      Justin Hibbits        Steve Kemp
+  Christoph Rissner   Karel Zak             Terry Chan
+  David Champion      Kirill Shutemov       Thomas Glanzmann
+  David Riebenbauer   Luke Macken           Thomer Gil
+  David Sterba        Mantas Mikulėnas      Tim Stoakes
+  David Wilson        Matteo Vescovi        Tyler Earnest
+  Don Zickus          Patrick Brisbin       Víctor Manuel Jáquez Leal
+  Elimar Riesebieter  Paul Miller           Vincent Lefevre
+  Eric Davis          Philippe Le Brouster  Vladimir Marek
+  Evgeni Golov        Phil Pennock          Vsevolod Volkov
+  Fabian Groffen      Raghavendra Prabhu
+  Felix von Leitner   Richard Russon
 
-A list of mirror sites can be found under
-<http://www.mutt.org/download.html>.
diff --git a/README.mutt b/README.mutt
new file mode 100644 (file)
index 0000000..70ef0c2
--- /dev/null
@@ -0,0 +1,28 @@
+README for mutt-1.5
+===================
+
+When updating mutt from an earlier release or from Mercurial, please
+make sure to read the compatibility notes in ``UPDATING''. Older changes
+between mutt-1.2 and mutt-1.4 are listed in NEWS.
+
+If you got the mutt source code from the public Mercurial repository
+(http://dev.mutt.org/hg/mutt/), please read doc/devel-notes.txt to make
+sure that you have a complete development environment.
+
+Installation instructions are detailed in ``INSTALL''. The user manual
+is in doc/manual.txt. PGP users should read doc/PGP-Notes.txt.
+
+Before you start hacking on mutt, read doc/devel-notes.txt.  Before
+applying patches to mutt, read doc/applying-patches.txt.  Please,
+read these files, as they will save you from asking FAQs.
+
+For more information, see the Mutt home page:
+
+ http://www.mutt.org/
+
+The primary distribution points for Mutt is:
+
+ ftp://ftp.mutt.org/pub/mutt
+
+A list of mirror sites can be found under
+<http://www.mutt.org/download.html>.
index bc87a919de34c5f1cdf2d2585ecadc0f4bb55780..b7dd935105cd201beb5a970714adba904306cf2f 100644 (file)
@@ -8144,6 +8144,16 @@ would contain:
 
 </sect2>
 
+<sect2 id="mutt-patches">
+<title>Mutt Patches</title>
+<para>
+Mutt may also be <quote>patched</quote> to support smaller features.
+These patches should add a free-form string to the end Mutt's version string.
+Running <literal>mutt -v</literal> might show:
+<screen>patch-1.5.24.sidebar.20151111</screen>
+</para>
+</sect2>
+
 <sect2 id="url-syntax">
 <title>URL Syntax</title>
 
index 5a37b3cc48e2adb2ecbf154d4aaf58aff8968add..d7ff0179fdd07eac589905ecea79007e30fbb89e 100644 (file)
@@ -9,17 +9,24 @@ div.table-contents table td, div.informaltable td, div.table-contents table th,
 div.table-contents table th, div.informaltable table th {
     font-family:sans-serif;
     background:#d0d0d0;
-    font-weight:normal;
+    font-weight:bold;
     vertical-align:top;
 }
-div.cmdsynopsis { border-left:1px solid #707070; padding-left:5px; }
+div.cmdsynopsis { border-left:1px solid #707070; padding-left: 1em; }
 li div.cmdsynopsis { border-left:none; padding-left:0px; }
-pre.screen, div.note { background:#f0f0f0; border:1px solid #c0c0c0; padding:5px; margin-left:2%; margin-right:2%; }
+li p { margin: 0; }
+pre.screen, div.note { border:1px solid #c0c0c0; margin-left:2%; margin-right:2%; }
+pre.screen { color: #ffffff; background:#000000; padding: 0.5em; }
+div.note { background:#ffff80; padding: 0.5em; }
 div.example p.title { margin-left:2%; }
 div.note h3 { font-size:small; font-style:italic; font-variant: small-caps; }
 div.note h3:after { content: ":" }
 div.note { margin-bottom: 5px; }
-.command { font-family: monospace; font-weight: normal; }
+div.literallayout, .command { font-family: monospace; font-weight: normal; }
 .command strong { font-weight: normal; }
 tr { vertical-align: top; }
-.comment { color:#707070; }
+.comment { color:#00c000; }
+code.literal { background: #f0f0f0; color: #000000; }
+span.indicator { background: #000060; color: #ffffff; }
+span.highlight { background: #404040; color: #ffffff; }
+span.reverse { background: #ffffff; color: #000000; }