From de8ebab3c687169afda60d9b0b803d88a9e5adcb Mon Sep 17 00:00:00 2001 From: inference Date: Mon, 18 Mar 2024 03:08:04 +0000 Subject: [PATCH] Update README --- README.adoc | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++ readme.adoc | 45 ------------------------------------------ 2 files changed, 56 insertions(+), 45 deletions(-) create mode 100644 README.adoc delete mode 100644 readme.adoc diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..0bd2234 --- /dev/null +++ b/README.adoc @@ -0,0 +1,56 @@ +[id=website] += <> + +This repository contains code and assets for the https://inferencium.net/[Inferencium] website. + + +[id=branches] +== <> + +[id=branches-alpha] +=== <> + +Pre-alpha development and alpha testing occurs in this branch. + +Fine-grained commits for each change are pushed to this branch and are tested internally. + +[id=branches-beta] +=== <> + +Feature-complete beta testing of merged code from alpha branch occurs in this branch. + +Merges from alpha branch to this branch are squashed, and the updated versions of the individual +files are mentioned in the commit messages. + +Code within this branch can be beta-tested at https://beta.inferencium.net/[Inferencium beta] website. + +[id=branches-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. + + +[id=security] +== <> + +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. + + +[id=licensing] +== <> + +Code is licensed under +https://src.inferencium.net/Inferencium/website/src/branch/stable/license/BSD-3-Clause.adoc[BSD 3-Clause License]. + +Non-code, personal content, including, but not limited to, blog posts, is licensed under +https://src.inferencium.net/Inferencium/website/src/branch/stable/license/CC-BY-ND-4.0.adoc[Creative Commons Attribution-NoDerivatives 4.0 International]. +This is stated as custom SPDX License Exception `AdditionRef-Inferencium-Personal-exception`. + +Assets are property of their owners and are used under fair use; restrictions may apply to the usage of assets. + diff --git a/readme.adoc b/readme.adoc deleted file mode 100644 index 17a1d68..0000000 --- a/readme.adoc +++ /dev/null @@ -1,45 +0,0 @@ -= Website - -Inferencium website. - - -[id=branches] -== <> - -=== https://src.inferencium.net/Inferencium/website/src/branch/alpha/[alpha] - -Pre-alpha development and alpha testing occurs in this branch. - -=== https://src.inferencium.net/Inferencium/website/src/branch/beta/[beta] - -Feature-complete beta testing of merged code from alpha branch occurs in this branch. + -Merges from alpha branch to this branch are squashed, and the updated versions of the individual -files are mentioned in the commit messages. - -=== https://src.inferencium.net/Inferencium/website/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. - - -[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. - - -[id=licensing] -== <> - -Code is licensed under -https://src.inferencium.net/Inferencium/website/src/branch/stable/license/BSD-3-Clause.adoc[BSD 3-Clause License]. - -Assets are property of their owners and are used under fair use; restrictions may apply to the usage -of assets. - -Personal content, including, but not limited to, blog posts, is copyrighted and cannot be -distributed or modified without explicit consent from Inferencium.