aboutsummaryrefslogtreecommitdiff
path: root/RELEASES
diff options
context:
space:
mode:
Diffstat (limited to 'RELEASES')
-rw-r--r--RELEASES28
1 files changed, 28 insertions, 0 deletions
diff --git a/RELEASES b/RELEASES
new file mode 100644
index 0000000..0c2e0e1
--- /dev/null
+++ b/RELEASES
@@ -0,0 +1,28 @@
+---Overview
+
+The silentct software is not stable and well-tested yet. Please read the NEWS
+file for information on how to upgrade from one beta version to the next.
+
+The git-tag convention for versioning is
+
+ beta.NUM
+
+where NUM is a monotonic counter.
+
+By the terms of the LICENSE you are free to use this code "as is" in almost any
+way you like. But for now, beta-use is only supported via the programs in cmd/.
+This means the NEWS file is only targeted towards users of the cmd/ programs.
+
+See
+
+ https://git.glasklar.is/rgdd/silentct/-/issues
+
+for an outlook of what we might be working on next.
+
+---Release cheat-sheet
+
+ * Makefile works and produces reasonable man pages
+ * Quickstart instructions in the README file works
+ * NEWS file describes what changed from a cmd/ perspective
+ * Bump version in README
+ * Push next beta.NUM tag