diff options
| author | Stephen J. Turnbull | 2013-05-14 13:14:34 +0900 |
|---|---|---|
| committer | Stephen J. Turnbull | 2013-05-14 13:14:34 +0900 |
| commit | 5103a8591d0368816bbad8a949269edc472f563a (patch) | |
| tree | bec06e00bb7b336b6bd6aa2906bf3f097d24f571 | |
| parent | 735376674b98aa9b72a7e560c29dad2590d08316 (diff) | |
| download | mailman-5103a8591d0368816bbad8a949269edc472f563a.tar.gz mailman-5103a8591d0368816bbad8a949269edc472f563a.tar.zst mailman-5103a8591d0368816bbad8a949269edc472f563a.zip | |
Some minor wording fixups.
| -rw-r--r-- | src/mailman/docs/START.rst | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/src/mailman/docs/START.rst b/src/mailman/docs/START.rst index 85b869c2d..9fffc3048 100644 --- a/src/mailman/docs/START.rst +++ b/src/mailman/docs/START.rst @@ -35,15 +35,18 @@ Requirements ============ Python 2.7 is required. It can either be the default 'python' on your -``$PATH`` or it can be accessible via the ``python2.7`` binary. -If your operating system does not include Python, see http://www.python.org -downloading and installing it from source. Python 3 is not yet supported. +``$PATH`` or it can be accessible via the ``python2.7`` binary. If +your operating system does not include Python, see http://www.python.org +for information about downloading installers (where available) and +installing it from source (when necessary or preferred). Python 3 is +not yet supported. In this documentation, a bare ``python`` refers to the Python executable used to invoke ``bootstrap.py``. -Mailman 3 is now based on the `zc.buildout`_ infrastructure, which greatly -simplifies testing Mailman. Buildout is not required for installation. +The Mailman 3 build is now based on the `zc.buildout`_ infrastructure, which +greatly simplifies testing Mailman. Buildout is not required for installation +of Mailman from a package. During the beta program, you may need some additional dependencies, such as a C compiler and the Python development headers and libraries. You will need an @@ -149,8 +152,9 @@ Try ``bin/mailman --help`` for more details. You can use the commands ``bin/mailman start`` to start the runner subprocess daemons, and of course ``bin/mailman stop`` to stop them. -Postorius is being developed as a separate, Django-based project. For now, -all configuration happens via the command line and REST API. +Postorius, a web UI for administration and subscriber settings, is being +developed as a separate, Django-based project. For now, the most flexible +means of configuration is via the command line and REST API. Mailman Web UI @@ -167,16 +171,16 @@ Postorius was prototyped at the `Pycon 2012 sprint`_, so it is "very alpha" as of Mailman 3 beta 1, and comes in several components. In particular, it requires a `Django`_ installation, and Bazaar checkouts of the `REST client module`_ and `Postorius`_ itself. Building it is fairly straightforward, -however, given Florian Fuchs' `Five Minute Guide` from his `blog post`_ on the +based on Florian Fuchs' `Five Minute Guide` from his `blog post`_ on the Mailman wiki. (Check the `blog post`_ for the most recent version!) The Archiver ------------ -In Mailman 3, the archivers are decoupled from the core engine. It is useful -to provide a simple, standard interface for third-party archiving tools and -services. For this reason, Mailman 3 defines a formal interface to insert +In Mailman 3, the archivers are decoupled from the core engine. Instead, +Mailman 3 provides a simple, standard interface for third-party archiving tools +and services. For this reason, Mailman 3 defines a formal interface to insert messages into any of a number of configured archivers, using whatever protocol is appropriate for that archiver. Summary, search, and retrieval of archived posts are handled by a separate application. |
