Project template

From ProgClub
Jump to: navigation, search

{project name} is the ProgClub {project's purpose} software. That's the software that {does what the project does}. It's a fork of {whatever you've copied} with {whatever you've added}. For other projects see projects.


We use semantic versioning. Latest production version: unreleased. Latest development version: 0.1.0.

See TODO for work that still needs to be done.


Why this software?



Members who have contributed to this project. Newest on top.

All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.

Upstream contributors:

  • {link to project's upstream contributors, or delete this section}


Copyright © 2020, Contributors.


Licensed under the {New BSD license, MIT license, GPL, or link to license file}.


Libraries, tools, services, or media from third parties used under license:

  • TODO: list 'em



TODO: link to downloads or explain why there aren't any.

Source code

The repository can be browsed online:

The latest stable released version of the code is available from:

Or if you want the latest version for development purposes:



Functional specification

The functional specification describes what the project does.

Technical specification

The technical specification describes how the project works.


See versioning for information on our semantic version numbers.

Notes for implementers

If you are interested in incorporating this software into your project, here's what you need to know:

Notes for developers

If you're looking to set up a development environment for this project here's what you need to know.

Get the latest code from the version branch:

$ svn checkout pcproject-0.1

You can then run the unit tests like this:

$ cd pcproject-0.1 && bin/test/

Note that you may need to install some dependencies, such as:

# apt install php-cli

Send your patch to along with a statement that you are willing to be listed in the contributors section of the documentation and willing to license your contribution under the license.

Notes for administrators

To release a version of this project use svnman.

First, run maintenance and commit any changes:

$ svnman sync

Then run the release:

$ release

You may be prompted to update the project documentation.

Generated documentation