Project template: Difference between revisions
m (Adding Administration and Resources sections.) |
(Improving default notes sections.) |
||
| Line 19: | Line 19: | ||
== Copyright == | == Copyright == | ||
Copyright 2012, [[Project template#Contributors|Contributors]]. Licensed under the {[[New BSD license|New BSD]], [[MIT license|MIT]], [[GPL]] or [https://svn.jj5.net/jjrepo/ link to license file]} license. | Copyright 2012, [[Project template#Contributors|Contributors]]. | ||
== License == | |||
Licensed under the {[[New BSD license|New BSD]], [[MIT license|MIT]], [[GPL]] or [https://svn.jj5.net/jjrepo/ link to license file]} license. | |||
= Resources = | = Resources = | ||
| Line 41: | Line 45: | ||
* [https://www.jj5.net/ add links here], put them in sections if that's appropriate | * [https://www.jj5.net/ add links here], put them in sections if that's appropriate | ||
= Functional specification = | = Specifications = | ||
== Functional specification == | |||
Describe what the project does. | Describe what the project does. | ||
= Technical specification = | == Technical specification == | ||
Describe how the project works. | Describe how the project works. | ||
| Line 65: | Line 71: | ||
* [[User:Sixsigma|JE]] {date}: created project page | * [[User:Sixsigma|JE]] {date}: created project page | ||
= Notes for implementers = | = Notes = | ||
== Notes for implementers == | |||
If you are interested in incorporating this software 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: | ||
There have been no implementation notes added yet. Sorry about that. Feel free to [mailto:jj5@jj5.net 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 [mailto:jj5@jj5.net jj5@jj5.net] along with a statement that you are willing to be listed in the [[Project_template#Contributors|contributors]] section of the documentation and willing to license your contribution under the [[Project_template#License|license]]. | |||
For security reasons write access to [https://svn.jj5.net/jjrepo/ jjrepo] is only available for [[User:Sixsigma|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 [https://www.progclub.org/ ProgClub] and [https://www.progclub.org/wiki/Register register]? | |||
Revision as of 06:34, 28 February 2012
{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.
Project 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
- add links here, put them in sections if that's appropriate
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?