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.

Status

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

See tasks for work that still needs to be done.

Motivation

Why this software?

Administration

Contributors

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

Copyright © 2017, Contributors.

License

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

Components

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

  • TODO: list 'em

Resources

Downloads

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

Source code

The repository can be browsed online:

https://www.progclub.org/pcrepo/pcproject/branches/0.1

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

https://www.progclub.org/svn/pcrepo/pcproject/tags/latest/0.1

Or if you want the latest version for development purposes:

https://www.progclub.org/svn/pcrepo/pcproject/branches/0.1

Links

Specifications

Functional specification

The functional specification describes what the project does.

Technical specification

The technical specification describes how the project works.

Notes

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:

Notes for ProgClub administrators

To release a version of this project use the pcrepo-branch-release script from the jj5-bin project:

$ pcrepo-branch-release {project name} $MAJOR.$MINOR $PATCH

Where:

$MAJOR = the major version number, presently 0
$MINOR = the minor version number, presently 1
$PATCH = the patch number for this release

See status for last production release.

Tasks

TODO

Things to do, in rough order of priority:

  • Create the project in svn

Done

Stuff that's done. Latest stuff on top.

  • JE {yyyy-mm-dd}: created project page