~sambuddhabasu1/mailman/fix_mailman_run_error

« back to all changes in this revision

Viewing changes to src/mailman/docs/README.txt

  • Committer: Barry Warsaw
  • Date: 2009-06-30 10:14:49 UTC
  • Revision ID: barry@list.org-20090630101449-hn6q37pycyughgpa
Integrate pylint and Sphinx documentation buildout targets.

* bin/lint.sh runs the linter (be very afraid)
* bin/docs runs Sphinx over the documentation (needs refining)

src/sphinxconf.py is an ugly hack to hook the buildout recipe so that we can
ignore text files in our tree that are not documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
================================================
 
2
Mailman - The GNU Mailing List Management System
 
3
================================================
 
4
 
 
5
This is `GNU Mailman`_, a mailing list management system distributed under the
 
6
terms of the `GNU General Public License`_ (GPL) version 3 or later.
 
7
 
 
8
Mailman is written in Python_, a free object-oriented programming language.
 
9
Python is available for all platforms that Mailman is supported on, which
 
10
includes GNU/Linux and most other Unix-like operating systems (e.g. Solaris,
 
11
\*BSD, MacOSX, etc.).  Mailman is not supported on Windows, although web and
 
12
mail clients on any platform should be able to interact with Mailman just
 
13
fine.
 
14
 
 
15
 
 
16
Copyright
 
17
=========
 
18
 
 
19
Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
 
20
          2008, 2009 by the Free Software Foundation, Inc.
 
21
 
 
22
This file is part of GNU Mailman.
 
23
 
 
24
GNU Mailman is free software: you can redistribute it and/or modify it under
 
25
the terms of the GNU General Public License as published by the Free Software
 
26
Foundation, either version 3 of the License, or (at your option) any later
 
27
version.
 
28
 
 
29
GNU Mailman is distributed in the hope that it will be useful, but WITHOUT ANY
 
30
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 
31
A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 
32
 
 
33
You should have received a copy of the GNU General Public License along with
 
34
GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
 
35
 
 
36
 
 
37
Spelling
 
38
========
 
39
 
 
40
The name of this software is spelled `Mailman` with a leading capital `M`
 
41
but with a lower case second `m`.  Any other spelling is incorrect.  Its full
 
42
name is `GNU Mailman` but is often referred colloquially as `Mailman`.
 
43
 
 
44
 
 
45
History
 
46
=======
 
47
 
 
48
Mailman was originally developed by John Viega.  Subsequent development
 
49
(through version 1.0b3) was by Ken Manheimer.  Further work towards the 1.0
 
50
final release was a group effort, with the core contributors being: Barry
 
51
Warsaw, Ken Manheimer, Scott Cotton, Harald Meland, and John Viega.  Version
 
52
1.0 and beyond have been primarily maintained by Barry Warsaw with
 
53
contributions from many; see the ACKNOWLEDGMENTS file for details.  Jeremy
 
54
Hylton helped considerably with the Pipermail code in Mailman 2.0.  Mailman
 
55
2.1 is now being primarily maintained by Mark Sapiro and Tokio Kikuchi.  Barry
 
56
Warsaw is the lead developer on Mailman 3.
 
57
 
 
58
 
 
59
Help
 
60
====
 
61
 
 
62
The Mailman home page is:
 
63
 
 
64
    http://www.list.org
 
65
 
 
66
with mirrors at:
 
67
 
 
68
    http://www.gnu.org/software/mailman
 
69
    http://mailman.sf.net
 
70
 
 
71
The community driven wiki (including the FAQ_) is at:
 
72
 
 
73
    http://wiki.list.org
 
74
 
 
75
Other help resources, such as on-line documentation, links to the mailing
 
76
lists and archives, etc., are available at:
 
77
 
 
78
    http://www.list.org/help.html
 
79
 
 
80
 
 
81
Requirements
 
82
============
 
83
 
 
84
Mailman 3.0 requires `Python 2.6` or newer.
 
85
 
 
86
 
 
87
.. _`GNU Mailman`: http://www.list.org
 
88
.. _`GNU General Public License`: http://www.gnu.org/licenses/gpl.txt
 
89
.. _Python: http://www.python.org
 
90
.. _FAQ: http://wiki.list.org/display/DOC/Frequently+Asked+Questions
 
91
.. _`Python 2.6`: http://www.python.org/download/releases/2.6.2/