diff --git a/README.md b/README.md deleted file mode 100644 index 75475de..0000000 --- a/README.md +++ /dev/null @@ -1,26 +0,0 @@ -
Inferencium script files.
-All content is licensed under BSD-3-Clause-Clear license.
-All files are checked for security issues; however, it is always the user's responsibility to
-audit the code before installing and/or executing it.
-
-Inferencium take no responsibility for any security issues which may arise due to usage of this
-repository.
Development branch. All pre-alpha development and alpha testing happens here.
-
-
Beta branch. All beta testing happens here.
-Stable branch. Complete and stable versions are stored here.
-
diff --git a/readme.adoc b/readme.adoc
new file mode 100644
index 0000000..35523be
--- /dev/null
+++ b/readme.adoc
@@ -0,0 +1,33 @@
+= Script
+
+Inferencium script files.
+
+== Licensing
+All content is licensed under https://git.inferencium.net/Inferencium/scr/src/branch/stable/license/BSD-3-Clause-Clear.txt[BSD 3 Clause Clear]
+license.
+
+== Security
+All files are checked for security issues; however, it is always the user's responsibility to audit
+the code before installing and/or executing it. +
+ +
+Inferencium take no responsibility for any security issues which may arise due to usage of this
+repository.
+
+== Branches
+
+=== https://git.inferencium.net/Inferencium/scr/src/branch/main/[main]
+Script repository root directory files pre-alpha development and alpha testing occurs in this
+branch. +
+Feature-complete modifications of this branch are merged to beta branch for beta testing.
+
+=== https://git.inferencium.net/Inferencium/scr/src/branch/beta/[beta]
+Feature-complete beta testing of merged code from development branches occurs in this branch. +
+Merges from development branches to this branch are squashed, and the updated versions of the
+individual files are mentioned in the commit messages.
+
+
+=== https://git.inferencium.net/Inferencium/scr/src/branch/stable/[stable]
+Feature-complete and tested versions from beta branch are stored in this branch. +
+Merges from beta branch to this branch are squashed, and the updated versions of the individual
+files are mentioned in the commit messages. +
+This branch contains code used in production.