From 901e9fa0c6c113ac7a00913c91e3b0eadc3733ab Mon Sep 17 00:00:00 2001 From: inference Date: Mon, 8 May 2023 23:47:07 +0100 Subject: [PATCH] Switch readme from HTML to Markdown formatting. --- README.md | 78 +++++++++++++++++++++++-------------------------------- 1 file changed, 32 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 8edb9b3..0d9ab6f 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,49 @@ -

Website

-

Inferencium website.

+# Website +Inferencium website.

-
-

Licensing

-

All content is licensed under BSD-3-Clause-Clear license*.
+## Licensing +All content is licensed under BSD-3-Clause-Clear license*.

*Exceptions:
-

    -
  1. All content outside of code, including personal content such as blog posts, is copyrighted and -cannot be distributed or modified without explicit consent from Inferencium.
  2. -
+* All content outside of code, including personal content such as blog posts, is copyrighted and +cannot be distributed or modified without explicit consent from Inferencium.

-
-

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

-

main

-

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

-
-

asset

-

Website asset, including multimedia, files pre-alpha development and alpha testing occurs in this +### asset +Website asset, including multimedia, 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.

+Feature-complete modifications of this branch are merged to beta branch for beta testing.

-

blog

-

Website blog 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.

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

-

contact

-

Website contact 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.

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

-

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

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

+individual files are mentioned in the commit messages.

-

stable

-

Feature-complete and tested versions from beta branch are stored in this branch.
+### 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.

-
+This branch contains code used in production.