Contributions:Contribution Wiki Template
Appearance
To create a wiki page for your own contribution, you may follow these steps:
- Log into the wiki using your BCI2000 SVN account.
- Create a new wiki page with the Contributions: name prefix, followed with the name of your contribution.
E.g., if your contribution is called TachyonADC, then the wiki page would be named Contributions:TachyonADC. - Copy-and-paste the wiki code given below into your new page, and modify it to fit your needs.
- Go to the Contributions:Contents page, and pick a category that applies to your contribution. On that category's page, add a link to your wiki page, followed with a very short summary.
==Synopsis==
(Shortly describe what your contribution does, and what the user
might use it for.)
==Location==
(Provide a link to the source code directory in the following form:)
http://{{SERVERNAME}}/svn/trunk/src/contrib/SignalSource/RDAClient
==Versioning==
===Author===
(Enter author and contact information as you feel appropriate.)
===Version History===
(Give a short list of changes when appropriate. The full history will always be recorded by SVN.)
===Source Code Revisions===
(In this section, indicate the BCI2000 source code revisions (changesets)
that you used when developing your contribution, and information about
testing/compilation. Adapt the list to your own needs.
Hint: You obtain the revision of a source code repository by
right-clicking its top level directory, and choosing "show log" from the
TortoiseSVN submenu.)
*Initial development: XXXX
*Tested under: YYYY
*Known to compile under: ZZZZ
*Broken since: UUUU
==Functional Description==
(Give a full description of what your contribution does. If the user
needs to perform additional installation steps, add an "Installation"
section.)
==Parameters==
(If the contribution is an ADC, signal processing filter, or application
module, then a description of each parameter should follow as indicated
by the examples. For other types of contributions, omit this section.)
===SomeParameter===
Description of the ''SomeParameter'' parameter.
===AnotherParameter===
Description of the ''AnotherParameter'' parameter.
==States==
(If the contribution is an ADC, signal processing filter, or application
module, then a description of each state should follow. For other types of
contributions, omit this section.)