view website/www/code.txt @ 7743:79779293d77b

doc: add reference to full email address and purpose for lists Added purpose for lists to the mailing list table. Also added headers. Some grammar fixups. Promote WebChat IRC interface over client interface as many people don't have clients installed anymore 8-(. Added a sentence that guides the user to the address of the mailing list. I added this after getting an issue about a request that should have gone to the mailing list. I realised there was no reference to the mailing lists' domain: @lists.sourceforge.net on the contact page. I think the linked subscribe page used to provide a hint, but it doesn't look like it does anymore. I wonder if we should add a mailto: link there? Does sphinx obscure it enough to prevent bot spamming?
author John Rouillard <rouilj@ieee.org>
date Wed, 21 Feb 2024 12:38:05 -0500
parents 6f5054751fb6
children 141225d2981e
line wrap: on
line source

.. meta::
    :description:
        Information for developers of Roundup. Including directions on
        checking code from repository, how to run demo mode and
        execute tests.

Code
====

Project history is maintained in `CHANGES.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt>`_
file in code repository of Roundup, which can also be viewed online
through SourceForge `web interface <https://sourceforge.net/p/roundup/code/ci/default/tree/>`_.

Get sources
-----------

Official **read-only access** to Mercurial repository is provided through ::

  hg clone http://hg.code.sf.net/p/roundup/code roundup

**Read/write access** requires SSH password or SSH key
authorization (see `SourceForge.net docs for details
<https://sourceforge.net/p/forge/documentation/Mercurial/>`_) ::

  hg clone ssh://USERNAME@hg.code.sf.net/p/roundup/code roundup

You also need to be added as a Roundup developer for write access - ask
for it on the :doc:`roundup-devel list <contact>`.

Run demo
--------

Roundup doesn't need any dependencies and works out of the box. Demo
is accessible at http://localhost:8917/demo/ by default ::

  cd roundup
  python demo.py

Execute tests
-------------
::

  python -m pytest test

See repository `README.txt <https://sourceforge.net/p/roundup/code/ci/tip/tree/README.txt>`_
for more info.

Roundup Issue Tracker: http://roundup-tracker.org/