Difference between revisions of "Maven distro directory layout"
From Gcube Wiki
(→distro) |
(→README) |
||
| Line 3: | Line 3: | ||
== README == | == README == | ||
| − | <source lang="text"> | + | <source lang="text" highlight="21,22,39,40,41"> |
The gCube System - ${name} | The gCube System - ${name} | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| − | + | ||
${description} | ${description} | ||
| − | |||
| + | ${gcube.description} | ||
| + | ${gcube.funding} | ||
| + | |||
| + | |||
Version | Version | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| − | + | ||
| − | ${version} | + | ${version} (${buildDate}) |
| − | + | ||
| − | + | ||
Authors | Authors | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| − | + | ||
* John Doe (john-AT-acme.org), Acme Inc., New York. | * John Doe (john-AT-acme.org), Acme Inc., New York. | ||
* [other maintainers] | * [other maintainers] | ||
| − | + | ||
| − | + | ||
Download information | Download information | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| − | + | ||
Source code is available from SVN: | Source code is available from SVN: | ||
${scm.url} | ${scm.url} | ||
| − | + | ||
Binaries can be downloaded from the gCube website: | Binaries can be downloaded from the gCube website: | ||
${gcube.website} | ${gcube.website} | ||
| − | + | ||
| − | + | ||
Documentation | Documentation | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| − | + | ||
Documentation is available on-line in the gCube Documentation Wiki: | Documentation is available on-line in the gCube Documentation Wiki: | ||
| − | ${gcube.wikiRoot}/[page name here] | + | Developer Guide - ${gcube.wikiRoot}/[page name here] |
| − | + | User Guide - ${gcube.wikiRoot}/[page name here] | |
| − | + | Admin Guide - ${gcube.wikiRoot}/[page name here] | |
| + | |||
Installation | Installation | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| − | + | ||
Please see the file named "INSTALL" in this directory. | Please see the file named "INSTALL" in this directory. | ||
| − | + | ||
| − | + | ||
Support | Support | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| − | + | ||
Bugs and support requests can be reported in the gcube issue tracking tool: | Bugs and support requests can be reported in the gcube issue tracking tool: | ||
${gcube.issueTracking} | ${gcube.issueTracking} | ||
| − | + | ||
| − | + | ||
Licensing | Licensing | ||
-------------------------------------------------- | -------------------------------------------------- | ||
| + | |||
| + | This software is licensed under the terms you may find in the file named "LICENSE" in this directory. | ||
| + | |||
| − | |||
</source> | </source> | ||
| + | |||
| + | Some notes: | ||
| + | * Documentation pages should always point to the ''component'' page, not to the documentation wiki root page | ||
| + | |||
| + | |||
| + | === Common properties === | ||
| + | Following properties are | ||
== LICENSE == | == LICENSE == | ||
asd | asd | ||
Revision as of 16:25, 3 March 2016
distro
README
The gCube System - ${name}
--------------------------------------------------
${description}
${gcube.description}
${gcube.funding}
Version
--------------------------------------------------
${version} (${buildDate})
Authors
--------------------------------------------------
* John Doe (john-AT-acme.org), Acme Inc., New York.* [other maintainers]
Download information
--------------------------------------------------
Source code is available from SVN:
${scm.url}
Binaries can be downloaded from the gCube website:
${gcube.website}
Documentation
--------------------------------------------------
Documentation is available on-line in the gCube Documentation Wiki:
Developer Guide - ${gcube.wikiRoot}/[page name here] User Guide - ${gcube.wikiRoot}/[page name here] Admin Guide - ${gcube.wikiRoot}/[page name here]
Installation
--------------------------------------------------
Please see the file named "INSTALL" in this directory.
Support
--------------------------------------------------
Bugs and support requests can be reported in the gcube issue tracking tool:
${gcube.issueTracking}
Licensing
--------------------------------------------------
This software is licensed under the terms you may find in the file named "LICENSE" in this directory.Some notes:
- Documentation pages should always point to the component page, not to the documentation wiki root page
Common properties
Following properties are
LICENSE
asd
