- Documentation of containers and adjusting page hierarchy

This commit is contained in:
2025-08-18 14:13:35 -04:00
parent 27754a56d7
commit 55a8c54119
28 changed files with 934 additions and 313 deletions

View File

@@ -8,21 +8,21 @@
<br><br>
## Table of Contents
<a id="table-of-contents"></a>
<h2>Table of Contents</h2>
<!-- TOC -->
* [Table of Contents](#table-of-contents)
* [Introduction](#introduction)
* [Coding Standards](#coding-standards)
* [Building from Source](#building-from-source)
* [Building from Terminal](#building-from-terminal)
* [Debian](#debian)
* [Fedora](#fedora-dnf) &rarr; `dnf`
* [Building on Windows](#building-on-windows)
* [Running the Test Suite](#running-the-test-suite)
* [Usage](#usage)
* [Licensing](#licensing)
* [Contribution](#contribution)
<!-- TOC -->
<br>
@@ -152,6 +152,7 @@ using specific toolchains for specific platforms that necessitate this. The prim
If you wish to build for Windows *and* Linux, your options are WSL or Dual Boot. I recommend Dual Boot over WSL.
<a id="debian"></a>
#### Debian
On Debian-based distributions, you can install dependencies using the following command:
@@ -165,6 +166,7 @@ for Doxygen run:
sudo apt install doxygen graphviz
```
<a id="fedora-dnf"></a>
#### Fedora (`dnf`)
On Debian-based distributions, you can install dependencies using the following command:
@@ -238,23 +240,26 @@ information displayed is correct.
## Usage
<a id="licensing"></a>
### Licensing
The following content of this section is not legal advice, nor is it legally binding, and nor does it change the terms
of the license. Please seek legal council if you have any concerns.
&ensp; fennec is licensed under GPLv3. The primary reason for the choice of license is to dissuade corporations from modifying
fennec and using it in a commercial manner. This of course does not bar them from using fennec commercially, however
it will prevent them from being able to make the derivative work proprietary. You are free to use and redistribute
fennec however you wish according to the terms of the license, which does not bar you from commercializing software
based on fennec.
TLDR; You may license your game under whichever license you please. Any C++ code that is by definition a derivative work
must be licensed under GPLv3 and freely available, everything else; assets, scripts, design documents, etc. may be under
the license of your choosing and remain proprietary.
&ensp; fennec is licensed under GPLv3. The primary reason for the choice of license is to dissuade corporations from
modifying fennec and using it in a commercial manner. This of course does not bar them from using fennec commercially,
however it will prevent them from being able to make the derivative work proprietary. You are free to use and redistribute
fennec however you wish according to the terms of the license, which does not bar you from commercializing software based
on fennec.
&ensp; If you wish to protect your game files, assets and generated content do not constitute a covered work and may be
copyrighted under a non-compliant license. Think of it in terms of using Blender to create a mesh for a game, then
licensing that mesh under another license.
Any code that is linked against fennec or uses any part is by definition a covered work must be licensed under GPLv3.
&ensp; Later down the line, I plan on implementing scripts in a manner that allows the script itself to remain proprietary.
The scripts will likely be trans-compiled to another language before being compiled to binary, but this is only an
intermediate step and will be erased when no longer needed.