Difference between revisions of "Project template"

From ProgClub
Jump to: navigation, search
Line 38: Line 38:
  
 
* [http://www.progclub.org/ add links here], put them in sections if that's appropriate
 
* [http://www.progclub.org/ add links here], put them in sections if that's appropriate
 +
 +
== Functional specification ==
 +
 +
Describe what the project does.
 +
 +
== Technical specification ==
 +
 +
Describe how the project works.
  
 
== TODO ==
 
== TODO ==

Revision as of 18:46, 5 December 2011

{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.

Project status

Under way. Not released yet, there's stuff TODO.

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 2011, Contributors. Licensed under the {New BSD, MIT, or GPL, or link to license file} license.

Source code

The repository can be browsed online:

http://www.progclub.org/pcrepo/

The code for {project name} is publicly available from svn:

http://www.progclub.org/svnro/pcrepo/

Or privately available for read-write access:

https://www.progclub.org/svn/pcrepo/

Links

Functional specification

Describe what the project does.

Technical specification

Describe how the project works.

TODO

Things to do, in rough order of priority:

  • Create the project in svn

Done

Stuff that's done. Latest stuff on top.

  • JE {date}: created project page

Notes for implementers

If you are interested in incorporating the ProgClub {project name} into your project, here's what you need to know: