From 6d8fc0a377eb80eac4a64b20b64927547e79971f Mon Sep 17 00:00:00 2001 From: inference Date: Tue, 9 May 2023 16:49:25 +0100 Subject: [PATCH] Update readme. --- README.md | 41 ++++++++++++++++++++++++----------------- 1 file changed, 24 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index cf51e37..fc30cf7 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,33 @@ -

Documentation

-

Inferencium documentation.

+# Documentation +Inferencium documentation.

+## Licensing +All content is licensed under Creative Commons Attribution 4.0 International license*.

-

Licensing

-

All content is licensed under CC-BY-4.0 license.

-
-
-

Security

-

All files are checked for security issues; however, it is always the user's responsibility to +## 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.

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

-

Branches

-

dev

-

Development branch. All pre-alpha development and alpha testing happens here.
+### 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

-

Beta branch. All beta testing happens here.

+### 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

-

Stable branch. Complete and stable versions are stored here.

-
+### 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.