add template for script documentation

2024-05-11 05:55:19 +00:00 · 2019-01-02 21:31:59 +01:00
parent 99e92340bc
commit 29a363649d
1 changed files with 47 additions and 0 deletions
--- a/template.md
+++ 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)