Difference between revisions of "Project template"

From ProgClub
Jump to: navigation, search
(Updating project template with H1 headings and extra sections.)
(Tidying up.)
Line 28: Line 28:
  
 
= Resources =
 
= Resources =
 +
 +
== Downloads ==
 +
 +
TODO: link to downloads or explain why there aren't any.
  
 
== Source code ==
 
== Source code ==
Line 51: Line 55:
 
== Functional specification ==
 
== Functional specification ==
  
Describe what the project does.
+
The functional specification describes what the project does.
  
 
== Technical specification ==
 
== Technical specification ==
  
Describe how the project works.
+
The technical specification describes how the project works.
 +
 
 +
= Notes =
 +
 
 +
== 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:
  
 
= Tasks =
 
= Tasks =
Line 72: Line 86:
  
 
* [[User:John|JE]] {date}: created project page
 
* [[User:John|JE]] {date}: created project page
 
= Notes =
 
 
== 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:
 

Revision as of 15:27, 25 March 2012

{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

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

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 2012, Contributors.

License

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

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/pcsvnrelease

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

https://www.progclub.org/svn/pcrepo/pcsvnrelease/tags/latest

Or if you want the latest version for development purposes:

svn://www.progclub.org/svn/pcrepo/pcsvnrelease/trunk

Links

Specifications

Functional specification

The functional specification describes what the project does.

Technical specification

The technical specification describes how the project works.

Notes

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:

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 {date}: created project page