doc/readme.adoc
2023-08-15 23:10:44 +01:00

58 lines
2.3 KiB
Plaintext

= Documentation
:docinfo: shared
Inferencium documentation.
[#branches]
== [.h-link]#<<branches,Branches>>#
=== https://src.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://src.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://src.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://src.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://src.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://src.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.
[#security]
== [.h-link]#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]
== [.h-link]#Licensing#
All content is licensed under
https://src.inferencium.net/Inferencium/doc/src/branch/stable/license/CC-BY-4.0.txt[Creative Commons Attribution 4.0 International]
license.