view website/www/code.txt @ 7744:6985f0ff3df3

doc: document lib, fix formating/example Add lib as an optional directory in a template. Make config_ini.ini example an actual code block using the file from the jinja2 template. Format the TEMPLATE-INFO.txt example as plain text (it was highlighting words like 'in' and 'with'). Also move the whole example under the bullet item, it was outside of the list. Reformat the input text to be less than 80 characters.
author John Rouillard <rouilj@ieee.org>
date Mon, 26 Feb 2024 11:23:36 -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/