diff --git a/README.md b/README.md deleted file mode 100644 index 8b88b3e..0000000 --- a/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# Documentation -Inferencium documentation.
-
-## Licensing -All content is licensed under 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 -### main -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.
-
-### security -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.
-
-### license -Documentation 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..849a49d --- /dev/null +++ b/readme.adoc @@ -0,0 +1,43 @@ += Documentation + +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. + +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. + +Feature-complete modifications of this branch are merged to beta branch for beta testing. + +=== https://git.inferencium.net/Inferencium/doc/src/branch/license/[license] +Documentation 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/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. + +=== 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. + +This branch contains code used in production.