From 91ec84e625af8ec25e37ee79adea34bf21f75e8b Mon Sep 17 00:00:00 2001 From: BodgeMaster <> Date: Wed, 6 Jul 2022 13:57:07 +0200 Subject: [PATCH] Documentation: Fix typos and formatting --- doc/build_system.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/doc/build_system.md b/doc/build_system.md index cdb2ea3..efd0027 100644 --- a/doc/build_system.md +++ b/doc/build_system.md @@ -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/`.