fennec-org/fennec
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- Update TOC in README.md

Browse Source
This commit is contained in:
Medusa Slockbower
2025-08-17 10:03:43 -04:00
parent 73041e994d
commit 5252ba84c9
1 changed files with 79 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -10,15 +10,20 @@
## Table of Contents ## Table of Contents
1. [Introduction](#introduction) <!-- TOC -->
1. [Coding Standards](#coding-standards) * [Table of Contents](#table-of-contents)
2. [Building from Source](#building-from-source) * [Introduction](#introduction)
1. [Building from Terminal](#building-from-terminal) * [Coding Standards](#coding-standards)
2. [Building on Windows](#building-on-windows) * [Building from Source](#building-from-source)
3. [Running the Test Suite](#running-the-test-suite) * [Building from Terminal](#building-from-terminal)
4. [Usage](#usage) * [Debian](#debian)
5. [Contribution](#contribution) * [Building on Windows](#building-on-windows)
6. [Documentation](./documentation.html) * [Running the Test Suite](#running-the-test-suite)
* [Usage](#usage)
* [Licensing](#licensing)
* [Contribution](#contribution)
<!-- TOC -->
<br> <br>
<br> <br>
@@ -142,16 +147,23 @@ for more info.
&ensp; By default, the CMake generator used is Ninja, which requires Ninja to be installed. You can modify the &ensp; By default, the CMake generator used is Ninja, which requires Ninja to be installed. You can modify the
build scripts to use another build manager, see the [CMake documentation for available generators](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html). build scripts to use another build manager, see the [CMake documentation for available generators](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html).
&ensp; I will at no point provide official cross-compilation toolchains for fennec. However, I will provide tools for
using specific toolchains for specific platforms that necessitate this. The primary examples would be Android and iOS.
If you wish to build for Windows *and* Linux, your options are WSL or Dual Boot. I recommend Dual Boot over WSL.
#### Debian
On Debian-based distributions, you can install dependencies using the following command: On Debian-based distributions, you can install dependencies using the following command:
```shell ```shell
sudo apt install build-essential cmake ninja-build libglew-dev valgrind sudo apt install build-essential cmake ninja-build libglew-dev valgrind
git submodule update --init --recursive git submodule update --init --recursive
``` ```
for Doxygen run:
&ensp; I will at no point provide official cross-compilation toolchains for fennec. However, I will provide tools for ```shell
using specific toolchains for specific platforms that necessitate this. The primary examples would be Android and iOS. sudo apt install doxygen graphviz
If you wish to build for Windows *and* Linux, your options are WSL or Dual Boot. I recommend Dual Boot over WSL. ```
<br> <br>