From 40775805be5bb4a4e9f6aad722c36cc4beb5ce93 Mon Sep 17 00:00:00 2001 From: inference Date: Thu, 13 Jul 2023 22:03:32 +0100 Subject: [PATCH] Update readme --- readme.adoc | 45 ++++++++++++++++++++++++--------------------- 1 file changed, 24 insertions(+), 21 deletions(-) diff --git a/readme.adoc b/readme.adoc index 586a2bb..81d2ef9 100644 --- a/readme.adoc +++ b/readme.adoc @@ -3,31 +3,21 @@ Inferencium documentation. -== Licensing - -All content is licensed under https://git.inferencium.net/Inferencium/doc/src/branch/stable/license/CC-BY-4.0.txt[Creative Commons Attribution 4.0 International] -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 takes no responsibility for any -security issues which may arise due to usage of this repository. - - == Branches === https://git.inferencium.net/Inferencium/doc/src/branch/main/[main] -Documentation root directory files pre-alpha development and alpha testing occurs in this -branch. + +Documentation 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/doc/src/branch/security/[security] -Documentation security files pre-alpha development and alpha testing occurs in this -branch. + +Documentation security 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/doc/src/branch/spec/[spec] + +Documentation specification 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/doc/src/branch/license/[license] @@ -38,12 +28,25 @@ Feature-complete modifications of this branch are merged to beta branch for beta === https://git.inferencium.net/Inferencium/doc/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. +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/doc/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. + +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. + + +== 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 takes no responsibility for any security issues which may arise due to usage +of this repository. + + +== Licensing + +All content is licensed under https://git.inferencium.net/Inferencium/doc/src/branch/stable/license/CC-BY-4.0.txt[Creative Commons Attribution 4.0 International] +license.