From 58f62310ccfa11b1b5072fe94058d1e76a26f87b Mon Sep 17 00:00:00 2001
From: Christian Wolf <git@christianwolf.email>
Date: Thu, 27 Feb 2025 08:02:22 +0100
Subject: [PATCH] Create template

---
 template/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 template/README.md

diff --git a/template/README.md b/template/README.md
new file mode 100644
index 0000000..d42a856
--- /dev/null
+++ b/template/README.md
@@ -0,0 +1,19 @@
+# Joomla Vorlage Christians Reifenscheune
+
+## Creating a release
+
+1. Bump the version. Best, use either of `make bump_patch`, `make bump_minor` or `make bump_major`.
+2. Create a tarball using `make tarball`.
+3. If everything is correct, you can push using `make push`.
+
+## Make targets
+
+- *css*: Build the CSS files from SCSS
+- *watch_css*: Keep building the CSS files using inotify for development
+- *bump_major*, *bump_minor* and *bump_patch*: Bump the corresponding version
+- *src/templateDetails.xml*: Create/update the manifest file.
+- *tarball*: Create a tarball in `res/tarballs` from the current state of the source folder. CSS and manifest will be build before
+- *push*: Push any releases in `res/tarballs` to the server and update the `updates.xml` file on the server. This target will do some sanity checks before to avoid data collision.
+- *push-force*: See push but overwrite existing releases
+
+Please note that `make push` will **not** generate a new tarball. So the user/developer is responsible for generation using `make tarball`.