From 4d595328b7ef55a29e0b8ca853d9e85673f83c9a Mon Sep 17 00:00:00 2001 From: inference Date: Sun, 7 Apr 2024 19:52:46 +0000 Subject: [PATCH] Update README --- readme.adoc => README.adoc | 80 ++++++++++++++++++++++++-------------- 1 file changed, 50 insertions(+), 30 deletions(-) rename readme.adoc => README.adoc (51%) diff --git a/readme.adoc b/README.adoc similarity index 51% rename from readme.adoc rename to README.adoc index efe21cc..b80524f 100644 --- a/readme.adoc +++ b/README.adoc @@ -3,61 +3,81 @@ Inferencium configuration files. -== Branches +[id=branch] +== <> -=== https://src.inferencium.net/Inferencium/cfg/src/branch/main/[main] +=== https://src.inferencium.net/Inferencium/cfg/src/branch/main[main] + +Configuration files root directory files pre-alpha development and alpha testing occurs in this branch. -Configuration files 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://src.inferencium.net/Inferencium/cfg/src/branch/aa000-0/[aa000-0] +=== https://src.inferencium.net/Inferencium/cfg/src/branch/aa000-0[aa000-0] + +System aa000-0 configuration files pre-alpha development and alpha testing occurs in this branch. -System aa000-0 configuration 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://src.inferencium.net/Inferencium/cfg/src/branch/xa000-0/[xa000-0] +=== https://src.inferencium.net/Inferencium/cfg/src/branch/xa000-0[xa000-0] + +System xa000-0 configuration files pre-alpha development and alpha testing occurs in this branch. -System xa000-0 configuration 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://src.inferencium.net/Inferencium/cfg/src/branch/xb000-0/[xb000-0] +=== https://src.inferencium.net/Inferencium/cfg/src/branch/xa000-1[xa000-1] + +System xa000-1 configuration files pre-alpha development and alpha testing occurs in this branch. -System xb000-0 configuration 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://src.inferencium.net/Inferencium/cfg/src/branch/license/[license] +=== https://src.inferencium.net/Inferencium/cfg/src/branch/xa000-2[xa000-2] + +System xa000-2 configuration files pre-alpha development and alpha testing occurs in this branch. -Configuration files license files pre-alpha and alpha testing occurs in this branch. + Feature-complete modifications of this branch are merged to beta branch for beta testing. -=== https://src.inferencium.net/Inferencium/cfg/src/branch/beta/[beta] +=== https://src.inferencium.net/Inferencium/cfg/src/branch/xb000-0[xb000-0] -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. +System xb000-0 configuration files pre-alpha development and alpha testing occurs in this branch. -=== https://src.inferencium.net/Inferencium/cfg/src/branch/stable/[stable] +Feature-complete modifications of this branch are merged to beta branch for beta testing. + +=== https://src.inferencium.net/Inferencium/cfg/src/branch/license[license] + +Configuration files license files pre-alpha and alpha testing occurs in this branch. + +Feature-complete modifications of this branch are merged to beta branch for beta testing. + +=== https://src.inferencium.net/Inferencium/cfg/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://src.inferencium.net/Inferencium/cfg/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. -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. -== Security +[id=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. +All files are checked for security issues; however, Inferencium takes no responsibility for any security issues which +may arise due to usage of this repository. -== Licensing +[id=licensing] +== <> -All content is licensed under -https://src.inferencium.net/Inferencium/cfg/src/branch/stable/license/BSD-3-Clause-Clear.txt[BSD 3-Clause Clear] -license*. + - + -*Excluding Linux configuration file(s), which are licensed under +All content (excluding Linux configuration files) is licensed under +https://src.inferencium.net/Inferencium/cfg/src/branch/stable/license/BSD-3-Clause.txt[BSD 3-Clause License]. + +Linux configuration files are licensed under https://src.inferencium.net/Inferencium/cfg/src/branch/stable/license/GPL-2.0-only.txt[GPLv2] license.