Template:Readme file
Jump to navigation
Jump to search
The following template description is not displayed when the template is inserted in an article.
Goal
This template can be used to link to the readme files in $FG_ROOT/Docs in the SourceForge repository.
Usage
{{readme file|file|folder|commit |nopath=}}
All parameters are optional.
- file
- Readme file name, not including
README.. If empty, the link will go to$FG_DATA/Docs/README.
- folder
- Sub-folder containing the readme file, see example below.
- commit
- Optional SHA-1 commit reference to use instead of the latest commit.
- nopath
- If not empty the path will not be shown.
Examples
* {{readme file|logging}}
- $FG_ROOT/Docs/README.logging
* {{readme file|model-combined.eff|folder=model-combined.eff}}
* {{readme file|commands|3=0591afe42cf7d78280f7999657034a6cf15a5649}}
- $FG_ROOT/Docs/README.commands
* {{readme file|materials|nopath=1}}