Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/groupserver/buildout

The code that goes into the GroupServer tar-ball.
https://github.com/groupserver/buildout

Last synced: about 2 months ago
JSON representation

The code that goes into the GroupServer tar-ball.

Awesome Lists containing this project

README

        

===========
GroupServer
===========
-------------------------------------------------
A mailing list manager with a great web interface
-------------------------------------------------

:Authors: Michael JasonSmith; Richard Waid; Alice Rose; Dan
Randow; Bill Bushey; Marek Kuziel
:Contact: Michael JasonSmith
:Date: 2015-12-16
:Organization: `GroupServer.org`_
:Copyright: This document is licensed under a
`Creative Commons Attribution-Share Alike 4.0 International
License`_
:Status: |build| |docs|

.. _Creative Commons Attribution-Share Alike 4.0 International License:
https://creativecommons.org/licenses/by-sa/4.0/

This is GroupServer_: a mailing-list manager with an excellent
integrated web interface.

* If you are looking at this ``README`` in a directory, then the
directory contains all the necessary information for
downloading and installing_ GroupServer. The system will be run
from a Python virtual-environment that is created in this
folder.

* If you are looking at the repository_ on GitHub, then this is
what goes into a release of GroupServer.

Installing
==========

An up-to-date version of installation documentation is
available from `Read the Docs`_, and a copy of the installation
instructions that were current when this version of GroupServer
was packaged is in the ``docs`` directory.

.. _GroupServer: http://groupserver.org/
.. _Read the Docs: http://groupserver.readthedocs.io/

The documentation for GroupServer can be generated by installing
Sphinx_ and running ``make`` in the ``docs`` directory:

.. code-block:: console

$ virtualenv --python=python2.7 .
$ . ./bin/activate
$ pip install Sphinx
$ cd docs
$ make html

The HTML documentation will be written to the ``_build/html``
folder.

.. _Sphinx: http://sphinx-doc.org/

Repository
==========

`The repository on GitHub`_ is named ``buildout`` because it uses
`zc.buildout`_ to download and install all the components that
make up the system. A release of GroupServer is little more than
the contents of the repository in a tar-ball [#hggit]_:

.. code-block:: console

$ hg archive -p groupserver-{yy}.{mm} -ttgz -X ".hg*" \
groupserver-{yy}.{mm}.tar.gz

.. _The repository on GitHub:
https://github.com/groupserver/buildout
.. _zc.buildout: https://pypi.python.org/pypi/zc.buildout/

.. [#hggit] Assuming that `Hg-Git`_ is used.
.. _Hg-Git: http://hg-git.github.io/

Resources
=========

- Documentation: http://groupserver.readthedocs.io/en/master
- Questions and comments to
http://groupserver.org/groups/development
- Report bugs at https://redmine.iopen.net/projects/groupserver
- Translate GroupServer at https://www.transifex.com/groupserver/public
- Code repository: https://github.com/groupserver/buildout
- Build status: https://travis-ci.org/groupserver/buildout

.. |build| image:: https://travis-ci.org/groupserver/buildout.svg?branch=master
:target: https://travis-ci.org/groupserver/buildout
:alt: Build Status
.. |docs| image:: http://readthedocs.io/projects/groupserver/badge/?version=master
:target: http://groupserver.readthedocs.io/en/master/?badge=master
:alt: Documentation Status

.. _GroupServer.org: http://groupserver.org/