Rewrite readme in AsciiDoc.

This commit is contained in:
inference 2023-05-12 03:13:20 +01:00
parent 80641ad7c3
commit 672b0c75c7
Signed by: inference
SSH Key Fingerprint: SHA256:9Pl0nZ2UJacgm+IeEtLSZ4FOESgP1eKCtRflfPfdX9M
2 changed files with 33 additions and 26 deletions

View File

@ -1,26 +0,0 @@
<h1>Script</h1>
<p>Inferencium script files.</p>
<br>
<br>
<h2>Licensing</h2>
<p>All content is licensed under BSD-3-Clause-Clear license.</p>
<br>
<br>
<h2>Security</h2>
<p>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 take no responsibility for any security issues which may arise due to usage of this
repository.</p>
<br>
<br>
<h2>Branches</h2>
<h3>dev</h3>
<p>Development branch. All pre-alpha development and alpha testing happens here.<br/>
<br>
<h3>beta</h3>
<p>Beta branch. All beta testing happens here.</p>
<br>
<h3>stable</h3>
<p>Stable branch. Complete and stable versions are stored here.<br/>
<br/>

33
readme.adoc Normal file
View File

@ -0,0 +1,33 @@
= Script
Inferencium script files.
== Licensing
All content is licensed under https://git.inferencium.net/Inferencium/scr/src/branch/stable/license/BSD-3-Clause-Clear.txt[BSD 3 Clause Clear]
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 take no responsibility for any security issues which may arise due to usage of this
repository.
== Branches
=== https://git.inferencium.net/Inferencium/scr/src/branch/main/[main]
Script repository 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/scr/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/scr/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.