Inferencium/website
1
0
Fork 0
Code Issues Activity

Improve README

Browse Source 
Rename `readme.adoc` to `README` since the latter is standardised. Also,
rearrange sections, and add extra information.
This commit is contained in:
inference 2024-03-18 00:46:38 +00:00
parent cdeeb241c4
commit 010bbd4102
Signed by: inference
SSH Key Fingerprint: SHA256:FtEVfx1CmTKMy40VwZvF4k+3TC+QhCWy+EmPRg50Nnc
1 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
readme.adoc → README
View File

@ -1,6 +1,6 @@
= Website = Website
Inferencium website. This repository contains code and assets for the https://inferencium.net/[Inferencium] website.
[id=branches] [id=branches]
@ -10,26 +10,32 @@ Inferencium website.
Pre-alpha development and alpha testing occurs in this branch. Pre-alpha development and alpha testing occurs in this branch.
Fine-grained commits for each change are pushed to this branch and are tested internally.
=== https://src.inferencium.net/Inferencium/website/src/branch/beta/[beta] === https://src.inferencium.net/Inferencium/website/src/branch/beta/[beta]
Feature-complete beta testing of merged code from alpha branch occurs in this branch. + Feature-complete beta testing of merged code from alpha branch occurs in this branch.
Merges from alpha branch to this branch are squashed, and the updated versions of the individual Merges from alpha branch to this branch are squashed, and the updated versions of the individual
files are mentioned in the commit messages. files are mentioned in the commit messages.
Code within this branch can be beta-tested at https://beta.inferencium.net/[Inferencium beta] website.
=== https://src.inferencium.net/Inferencium/website/src/branch/stable/[stable] === https://src.inferencium.net/Inferencium/website/src/branch/stable/[stable]
Feature-complete and tested versions from beta branch are stored in this branch. + 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 Merges from beta branch to this branch are squashed, and the updated versions of the individual
files are mentioned in the commit messages. + files are mentioned in the commit messages.
This branch contains code used in production. This branch contains code used in production.
[id=security] [id=security]
== <<security,Security>> == <<security,Security>>
All files are checked for security issues; however, it is always the user's responsibility to audit All files are checked for security issues; however, Inferencium takes no responsibility for any security issues which
the code before installing and/or executing it. Inferencium takes no responsibility for any security may arise due to usage of this repository.
issues which may arise due to usage of this repository.
[id=licensing] [id=licensing]
@ -38,8 +44,9 @@ issues which may arise due to usage of this repository.
Code is licensed under Code is licensed under
https://src.inferencium.net/Inferencium/website/src/branch/stable/license/BSD-3-Clause.adoc[BSD 3-Clause License]. https://src.inferencium.net/Inferencium/website/src/branch/stable/license/BSD-3-Clause.adoc[BSD 3-Clause License].
Personal content, including, but not limited to, blog posts, is copyrighted and cannot be
distributed or modified without explicit consent from Inferencium.
Assets are property of their owners and are used under fair use; restrictions may apply to the usage Assets are property of their owners and are used under fair use; restrictions may apply to the usage
of assets. of assets.
Personal content, including, but not limited to, blog posts, is copyrighted and cannot be
distributed or modified without explicit consent from Inferencium.