diff --git a/README.md b/README.md index fbef7e7..bb9b50f 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,48 @@ -
Inferencium configuration files.
+# Configuration +Inferencium configuration files.All content is licensed under BSD-3-Clause-Clear license*.
+## Licensing
+All content is licensed under BSD-3-Clause-Clear license*.
-*Excluding Linux configuration file(s), which are licensed under GPL-2.0-only license.
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.
+## 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.
Development branch. All pre-alpha development and alpha testing happens here.
+## Branches
+### main
+Configuration files 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.
-
Beta branch. All beta testing happens here.
+### desktop +Desktop configuration files pre-alpha development and alpha testing occurs in this branch.Stable branch. Complete and stable versions are stored here.
-
+### server
+Server configuration 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.
+
+### license
+Configuration files 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
+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
+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.