Inferencium/doc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rewrite readme in AsciiDoc.

Browse Source
This commit is contained in:
inference 2023-05-12 01:49:58 +01:00
parent b91e89fb43
commit 1114ae1928
Signed by: inference
SSH Key Fingerprint: SHA256:9Pl0nZ2UJacgm+IeEtLSZ4FOESgP1eKCtRflfPfdX9M
2 changed files with 43 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -1,38 +0,0 @@
# 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.

43
readme.adoc Normal file
View File

@ -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.