Template:AppStub: Difference between revisions
Jpr@uab.edu (talk | contribs) (→How to build {{{1}}}: Fix link to App best practices page) |
Jpr@uab.edu (talk | contribs) (Convert to App instead of software to match RCS app philosophy. Add intro reference to tell people what to do in stub.) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
'''{{{1}}}''' | '''{{{1}}}''' | ||
This is the AppStub template. Replace it's content with your own content for your specific App. See [[AppBuidBestPractices#At_a_minimum.2C_document_your_effort_in_the_docs_wiki|App Build Best Practices]] for more information. | |||
First write a short blurb about what this App does and who might be interested in using it. You should provide a link to the [http://example.org upstream project]. A [[wikipedia:Wikipedia|Wikipedia page name]] reference can be helpful here, if it it exists. | |||
== How to use {{{1}}} == | == How to use {{{1}}} == | ||
Latest revision as of 16:52, 30 October 2013
{{{1}}}
This is the AppStub template. Replace it's content with your own content for your specific App. See App Build Best Practices for more information.
First write a short blurb about what this App does and who might be interested in using it. You should provide a link to the upstream project. A Wikipedia page name reference can be helpful here, if it it exists.
How to use {{{1}}}
How to use the software. Describe how to use it on the cluster by setting your environment.
Better yet, write a modules file and tell folks what module they need to load
module load {{{1}}}
How to build {{{1}}}
Describe the steps followed to build this software.
NOTE: This is critical to reproducible research and should be considered a core part of your research notebook.
Make sure you are using AppBuildBestPractices
Getting Help
If you are providing support for this software on the cluster let folks know how to reach you. At least let the know where they can find help online in the upstream community.
References
At a minimum record the link to the upstream project from where you got this software.
See Editing_Docs for information on how to edit pages on this site.