From 2853858807d29548a75f19429646b48ac0004870 Mon Sep 17 00:00:00 2001
From: Charadon <dev@iotib.net>
Date: Wed, 28 Sep 2022 16:07:28 -0400
Subject: templates.txt: Added to document how Templates work.

---
 docs/templates.txt | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 docs/templates.txt

(limited to 'docs/templates.txt')

diff --git a/docs/templates.txt b/docs/templates.txt
new file mode 100644
index 0000000..19eb19d
--- /dev/null
+++ b/docs/templates.txt
@@ -0,0 +1,20 @@
+In the setup script, you can specify a directory that contains templates.
+
+This directory can contain:
+pre.sh
+post.sh
+build.sh
+failed.sh
+
+This can be helpful if you have multiple projects that build pretty much
+exactly the same. Or are extremely similar and only require small
+modifications, rather than writing the entire scripts from scratch.
+
+When using the setup.sh script, you can specify the directory by using
+-t /path/to/templates. A template directory looks like this:
+
+templates/
+├── build.sh
+├── failed.sh
+├── post.sh
+└── pre.sh
-- 
cgit 1.4.1-2-gfad0