Difference between revisions of "Project template"

From ProgClub
Jump to: navigation, search
(→‎Copyright: Updating copyright year on project template.)
(Updating project template with H1 headings and extra sections.)
Line 1: Line 1:
{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 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 ==
+
= Status =
  
Under way. Not released yet, there's stuff [[Project template#TODO|TODO]].
+
Under way. Not released yet, there's stuff [[#TODO|TODO]].
 +
 
 +
= Administration =
  
 
== Contributors ==
 
== Contributors ==
Line 19: Line 21:
 
== Copyright ==
 
== Copyright ==
  
Copyright 2012, [[Project template#Contributors|Contributors]]. Licensed under the {[[New BSD license|New BSD]], [[MIT license|MIT]], or [[GPL]], or [http://www.progclub.org/svnro/pcrepo/ link to license file]} license.
+
Copyright 2012, [[#Contributors|Contributors]].
 +
 
 +
== License ==
 +
 
 +
Licensed under the {[[New BSD license|New BSD]], [[MIT license|MIT]], or [[GPL]], or [https://www.progclub.org/pcrepo/ link to license file]} license.
 +
 
 +
= Resources =
  
 
== Source code ==
 
== Source code ==
Line 25: Line 33:
 
The repository can be browsed online:
 
The repository can be browsed online:
  
  http://www.progclub.org/pcrepo/
+
  https://www.progclub.org/pcrepo/pcsvnrelease
  
The code for {project name} is publicly available from svn:
+
The latest stable released version of the code is available from:
  
  http://www.progclub.org/svnro/pcrepo/
+
  https://www.progclub.org/svn/pcrepo/pcsvnrelease/tags/latest
  
Or privately available for read-write access:
+
Or if you want the latest version for development purposes:
  
  https://www.progclub.org/svn/pcrepo/
+
  svn://www.progclub.org/svn/pcrepo/pcsvnrelease/trunk
  
 
== Links ==
 
== Links ==
  
* [http://www.progclub.org/ add links here], put them in sections if that's appropriate
+
* [https://www.progclub.org/ add links here], put them in sections if that's appropriate
 +
 
 +
= Specifications =
  
 
== Functional specification ==
 
== Functional specification ==
Line 46: Line 56:
  
 
Describe how the project works.
 
Describe how the project works.
 +
 +
= Tasks =
  
 
== TODO ==
 
== TODO ==
Line 60: Line 72:
  
 
* [[User:John|JE]] {date}: created project page
 
* [[User:John|JE]] {date}: created project page
 +
 +
= Notes =
  
 
== Notes for implementers ==
 
== Notes for implementers ==
  
If you are interested in incorporating the ProgClub {project name} into your project, here's what you need to know:
+
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 08:01, 15 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

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

Describe what the project does.

Technical specification

Describe how the project works.

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

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: