Project template

From John's wiki
Revision as of 15:46, 28 February 2012 by Sixsigma (talk | contribs) (Renaming 'Project status' as just 'Status' to see if I like that better. :P)
Jump to navigation Jump to 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

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

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:

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

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?