aboutsummaryrefslogtreecommitdiffstats
path: root/template.md
diff options
context:
space:
mode:
authorGravatar Christian Hesse <mail@eworm.de>2019-01-02 21:31:59 +0100
committerGravatar Christian Hesse <mail@eworm.de>2019-01-02 21:31:59 +0100
commit29a363649dc672dd1202a9222e63fe3907548518 (patch)
tree0b36017e671aa5ecd304aecef00398d84f668589 /template.md
parent99e92340bc676a37ea5d9d53ce02e3647e46a9f4 (diff)
add template for script documentation
Diffstat (limited to 'template.md')
-rw-r--r--template.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/template.md b/template.md
new file mode 100644
index 0000000..8a9aeb7
--- /dev/null
+++ b/template.md
@@ -0,0 +1,47 @@
+Script `template`
+=================
+
+[◀ Go back to main README](README.md)
+
+Description
+-----------
+
+Short description...
+
+In detail
+---------
+
+Get all the details...
+
+Requirements and installation
+-----------------------------
+
+We need...
+
+... then we install:
+
+ [admin@MikroTik] > / system script add name=template
+ [admin@MikroTik] > / system script run script-updates
+
+Configuration
+-------------
+
+The configuration goes to `global-config`, These are the parameters:
+
+* ...
+
+Usage and invocation
+--------------------
+
+This is intended...
+
+See also
+--------
+
+* [another script](template.md)
+* ...
+
+---
+[◀ Go back to main README](README.md)
+
+[▲ Go back to top](#top)