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.
Usage
{{readme file|file path|commit |nopath=}}
Both parameters are optional.
- file path
- Path and filename starting from but not including
/data/
. Defaults to README.
- 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|README.logging}}
- $FG_ROOT/Docs/README.logging
* {{readme file|README.commands|0591afe42cf7d78280f7999657034a6cf15a5649}}
- $FG_ROOT/Docs/README.commands