From db9e9b428789159d30a45864976958958eb112d6 Mon Sep 17 00:00:00 2001 From: inference Date: Fri, 12 May 2023 03:22:39 +0100 Subject: [PATCH] Rewrite readme in AsciiDoc. --- README.md | 49 ------------------------------------------------- readme.adoc | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 49 deletions(-) delete mode 100644 README.md create mode 100644 readme.adoc diff --git a/README.md b/README.md deleted file mode 100644 index 1971970..0000000 --- a/README.md +++ /dev/null @@ -1,49 +0,0 @@ -# Website -Inferencium website.
-
-## Licensing -All content is licensed under BSD 3 Clause Clear license*.
-
-*Exceptions:
-* All content outside of code, including personal content such as blog posts, is copyrighted and -cannot be distributed or modified without explicit consent from Inferencium.
-
-## 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 -### main -Website 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.
-
-### asset -Website asset, including multimedia, 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.
-
-### blog -Website blog 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.
-
-### contact -Website contact 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.
-
-### license -Website 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.
-
-### 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.
-
-### 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. diff --git a/readme.adoc b/readme.adoc new file mode 100644 index 0000000..203e644 --- /dev/null +++ b/readme.adoc @@ -0,0 +1,52 @@ += Website + +Inferencium website. + +== Licensing +All content is licensed under https://git.inferencium.net/Inferencium/website/src/branch/stable/license/BSD-3-Clause-Clear.txt[BSD 3 Clause Clear] +license*. + + + +*Exceptions: +* All content outside of code, including personal content such as blog posts, is copyrighted and +cannot be distributed or modified without explicit consent from Inferencium. + +== 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/website/src/branch/main/[main] +Website 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/website/src/branch/asset/[asset] +Website asset, including multimedia, 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/website/src/branch/blog/[blog] +Website blog 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/website/src/branch/contact/[contact] +Website contact 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/website/src/branch/license/[license] +Website 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://git.inferencium.net/Inferencium/website/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/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.