Difference between revisions of "Project template"

From ProgClub
Jump to: navigation, search
 
(26 intermediate revisions by the same user not shown)
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]].
+
We use [[Versioning|semantic versioning]].
 +
Latest production version: unreleased.
 +
Latest development version: 0.1.0.
 +
 
 +
See [[#TODO|TODO]] for work that still needs to be done.
 +
 
 +
= Motivation =
 +
 
 +
Why this software?
 +
 
 +
= Administration =
  
 
== Contributors ==
 
== Contributors ==
Line 9: Line 19:
 
Members who have contributed to this project. Newest on top.
 
Members who have contributed to this project. Newest on top.
  
* [[User:John|John]]
+
* [[User:John|John Elliot V]]
 +
 
 +
All contributors have agreed to the terms of the [[ProgClub:Copyrights#ProgClub_projects|Contributor License Agreement]]. This excludes any upstream contributors who tend to have different administrative frameworks.
  
Up-stream contributors:
+
Upstream contributors:
  
 
* {link to project's upstream contributors, or delete this section}
 
* {link to project's upstream contributors, or delete this section}
Line 17: Line 29:
 
== Copyright ==
 
== Copyright ==
  
Copyright 2011, [[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 © 2020, [[#Contributors|Contributors]].
 +
 
 +
== License ==
 +
 
 +
Licensed under the {[[New BSD license]], [[MIT license]], [[GPL]], or [https://www.progclub.org/pcrepo/ 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 ==
 
== Source code ==
  
The code for {project name} is publicly available from svn:
+
The repository can be browsed online:
  
  http://www.progclub.org/svnro/pcrepo/
+
  https://www.progclub.org/pcrepo/pcproject/branches/0.1
  
Or privately available for read-write access:
+
The latest stable released version of the code is available from:
  
  https://www.progclub.org/svn/pcrepo/
+
  https://www.progclub.org/svn/pcrepo/pcproject/tags/latest/0.1
  
The repository can be browsed online:
+
Or if you want the latest version for development purposes:
  
  http://www.progclub.org/pcrepo/
+
  https://www.progclub.org/svn/pcrepo/pcproject/branches/0.1
  
 
== 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
  
== TODO ==
+
= Specifications =
  
Things to do, in rough order of priority:
+
== Functional specification ==
  
* Create the project in svn
+
The functional specification describes what the project does.
  
[[Category:TODO]]
+
== Technical specification ==
  
== Done ==
+
The technical specification describes how the project works.
  
Stuff that's done. Latest stuff on top.
+
= Notes =
  
* [[User:John|JE]] {date}: created project page
+
See [[versioning]] for information on our semantic version numbers.
  
 
== 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.
 +
 
 +
Get the latest code from the version branch:
 +
 
 +
$ <code>svn checkout https://www.progclub.org/svn/pcrepo/pcproject/branches/0.1 pcproject-0.1</code>
 +
 
 +
You can then run the unit tests like this:
 +
 
 +
$ <code>cd pcproject-0.1 && bin/test/test.sh</code>
 +
 
 +
Note that you may need to install some dependencies, such as:
 +
 
 +
# <code>apt install php-cli</code>
 +
 
 +
Send your patch to [mailto:jj5@progclub.org?subject=pcproject jj5@progclub.org] along with a statement that you are willing to be listed in the [[#Contributors|contributors]] section of the documentation and willing to license your contribution under the [[#License|license]].
 +
 
 +
== Notes for administrators ==
 +
 
 +
To release a version of this project use [[svnman]].
 +
 
 +
First, run maintenance and commit any changes:
 +
 
 +
$ <code>svnman sync</code>
 +
 
 +
Then run the release:
 +
 
 +
$ <code>release</code>
 +
 
 +
You may be prompted to update the project documentation.
 +
 
 +
= Generated documentation =

Latest revision as of 08:37, 14 April 2021

{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 TODO 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 © 2020, 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.

Get the latest code from the version branch:

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

You can then run the unit tests like this:

$ cd pcproject-0.1 && bin/test/test.sh

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

# apt install php-cli

Send your patch to jj5@progclub.org 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