Update template
This commit is contained in:
parent
2f94600859
commit
9d98352e65
2 changed files with 65 additions and 17 deletions
48
doc/template.md
Normal file
48
doc/template.md
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
# Script name
|
||||
|
||||
[⬅️ Go back to main README](../README.md)
|
||||
|
||||
> ℹ️ **Info**: This script can not be used on its own but requires the base
|
||||
> installation. See [main README](../README.md) for details.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Script name](#script-name)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [Description](#description)
|
||||
- [Requirements and installation](#requirements-and-installation)
|
||||
- [Configuration](#configuration)
|
||||
- [Usage and invocation](#usage-and-invocation)
|
||||
- [See also](#see-also)
|
||||
|
||||
## Description
|
||||
|
||||
Function description of the script and which goal it should achieve.
|
||||
|
||||
## Requirements and installation
|
||||
|
||||
Just install the script:
|
||||
|
||||
```rsc
|
||||
$ScriptInstallUpdate script-file-name-without-filename-extension "base-url=https://git.s1q.dev/phg/routeros-scripts-custom/raw/branch/main/";
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
What to configure to run the script
|
||||
|
||||
## Usage and invocation
|
||||
|
||||
How to run the script:
|
||||
|
||||
```rsc
|
||||
/system/script/run script-file-name-without-filename-extension;
|
||||
```
|
||||
|
||||
## See also
|
||||
|
||||
* ...
|
||||
|
||||
---
|
||||
[⬅️ Go back to main README](../README.md)
|
||||
[⬆️ Go back to top](#top)
|
||||
Loading…
Add table
Add a link
Reference in a new issue