BAR Readme

The goal of the BAR Readme format is to provide readability while allowing automatic processing by TRAC. To allow TRAC to understand any Readme data, some meta information is required. This meta information is provided by tags. Tagged content will appear in the application's TRAC wiki page while any untagged content is not processed by TRAC and will be visible only in the Readme itself. In addition some tags are mandatory.

Format

1. Mandatory tags: [Name], [Contact Person], [Access Level], [License Agreement], [Platform]
2. Tags follow the syntax:
   • "[tag]:" single string
   • "[tag]" multiline text
3. Multiline tags include any formatted text until next tag or EOF and can include any TRAC understandable formatting directives. Single string tags accept only one single line string. Mandatory tags represent single string tags. Tags start with '[' as the first character in a line.

More information on WIKI formatting can be found here: WikiFormatting.

Note

Important: In case [Name] or [Access level] tags are required to be modified, the Readme needs to be removed from SVN, modified and added to SVN rather than submitting a modification to SVN.

---

Example

This is the Readme for:
Argon Molecular Dynamics Readme                           

[Name]: Argon Molecular Dynamics  
[Contact Person]: John Smith, jsmith@domain.com
[Access Level]: public
[License Agreement]: GPL
[Platform]: CellSs, SMPSs

[Body]
 == Description ==
This application is a (Molecular dynamics) simulation of the behavior of the a set of argon atoms in a constant volume container at 300 degrees K. Newtonian
laws are applied to update the movement of each atom due to electrostatic forces between them.

== Description ==

== Origin ==

== General Algorithm ==

== Versions ==

== Version 1 ==

== Version 2 ==

…

== Know issues ==

== Open Tickets list... ==

== Execution instructions ==

== Performance Results ==

== References ==

== Downloads ==

== Source code ==

== Input sets ==

== Traces ==

== Other ==