Project template

From Sixsigma
Jump to: navigation, search

{project name} is John's {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

People who have contributed to this project. Newest on top.

Upstream contributors:

  • {link to project's upstream contributors, or delete this section}

Copyright

Copyright 2012, Contributors.

License

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

Resources

Downloads

Provide information about where to download the software, or delete this section if there are no downloads.

Source code

The repository can be browsed online:

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

Or if you want the latest version for development purposes:

Links

Specifications

Functional specification

In the functional specification we describe what the project does.

Technical specification

In the technical specification we describe 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:

There have been no implementation notes added yet. Sorry about that. Feel free to ask questions.

TODO: add notes about installation.

Notes for developers

If you're interested in contributing to this software, here's what you need to know:

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

For security reasons write access to jjrepo is only available for John. It's basically my private repository. If you'd like to hack on projects where you do have checkin permissions on the Subversion repository, along with infrastructure for running your code, then why not head over to ProgClub and register?

Configuring a development environment

TODO: add notes about how to configure a development environment.

Releasing a stable version

Releases of {project name} can only be done by John. To do a release run the jjrepo-release script from either empathy or orac. E.g.:

jj5@orac:~$ jjrepo-release {project name}

If you've noticed that there is code in trunk that hasn't been released into tags/latest and you'd like John to do a release for you then feel free to drop him a line.

Release notes

Release notes are (supposed to be) added after notable releases are made. New release notes are added to the bottom of the release notes section and have a level 3 title based on the release date.

Tasks

TODO

Things to do, in rough order of priority:

  • Create the project in svn.

Done

Stuff that's done. Latest stuff goes on the bottom of the list.

{date}

  • JE: Create project page.