BodgeMaster
/
FOSS-VG
1
0
Fork 0
Code Issues 21 Pull Requests Projects Releases Wiki Activity

Documentation: Fix typos and formatting

BodgeMaster-unfinished
BodgeMaster 2022-07-06 13:57:07 +02:00
parent 847b73c6ae
commit 91ec84e625
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/build_system.md
View File

@ -1,4 +1,4 @@
# FOSS-VG Buils System
# FOSS-VG Build System
Yeah, I was annoyed at make. Sorry. -BodgeMaster
@ -24,21 +24,27 @@ Provided aliases:
## setup_project
Cleans the project and its dependencies first, ensuring the project is in a known state, then downloads and extracts dependencies.
Cleans the project and its dependencies first, ensuring the project is in
a known state, then downloads and extracts dependencies.
This will probably do more in the future (for example compile dependencies that need to be compiled).
This will probably do more in the future (for example compile dependencies
that need to be compiled).
# build
Builds the project. This will compile all the things in `src/` except for what is in `src/test/`.
Builds the project. This will compile all the things in `src/` except for
what is in `src/test/`.
Checks for endianness if endianness header is missing. Builds the endianness check if that is missing as well.
Checks for endianness if endianness header is missing.
Builds the endianness check if that is missing as well.
Accepted environment variables:
- `CXX`: override the default compiler
- `CXXFLAGS`: override the default compiler flags, must at least specify the C++ version
- `SINGLE`: if set to `yes`, causes the build script to run in single-threaded mode
- `CXXFLAGS`: override the default compiler flags, must at least specify
the C++ version
- `SINGLE`: if set to `yes`, causes the build script to run in
single-threaded mode
# test / run_tests
@ -47,14 +53,16 @@ Builds and runs the unit tests.
Accepted environment variables:
- `CXX`: override the default compiler
- `CXXFLAGS`: override the default compiler flags, must at least specify the C++ version
- `CXXFLAGS`: override the default compiler flags, must at least specify
the C++ version
# clean
Removes and re-creates `bin/`. Also removes the endianness header and the endianness check.
Removes and re-creates `bin/`. Also removes the endianness header and
the endianness check binary.
# clean_dependencies
Removes and re-created `dependencies/`.
Removes and re-creates `dependencies/`.