doc/README.md

39 lines
2.1 KiB
Markdown

# Documentation
Inferencium documentation.<br>
<br>
## Licensing
All content is licensed under <a href="https://git.inferencium.net/Inferencium/doc/src/branch/stable/license/CC-BY-4.0.txt">Creative Commons Attribution 4.0 International</a> license.<br>
<br>
## 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.<br>
<br>
Inferencium takes no responsibility for any security issues which may arise due to usage of this
repository.<br>
<br>
## Branches
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/main/">main</a>
Documentation root directory files pre-alpha development and alpha testing occurs in this
branch.<br>
Feature-complete modifications of this branch are merged to beta branch for beta testing.<br>
<br>
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/security/">security</a>
Documentation security files pre-alpha development and alpha testing occurs in this
branch.<br>
Feature-complete modifications of this branch are merged to beta branch for beta testing.<br>
<br>
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/license/">license</a>
Documentation license files pre-alpha and alpha testing occurs in this branch.<br>
Feature-complete modifications of this branch are merged to beta branch for beta testing.<br>
<br>
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/beta/">beta</a>
Feature-complete beta testing of merged code from development branches occurs in this branch.<br>
Merges from development branches to this branch are squashed, and the updated versions of the
individual files are mentioned in the commit messages.<br>
<br>
### <a href="https://git.inferencium.net/Inferencium/doc/src/branch/stable/">stable</a>
Feature-complete and tested versions from beta branch are stored in this branch.<br>
Merges from beta branch to this branch are squashed, and the updated versions of the individual
files are mentioned in the commit messages.<br>
This branch contains code used in production.