fSD/yait
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix spelling and formatting

Browse Source
This commit is contained in:
vx-clutch
2025-09-10 16:24:59 -04:00
parent 9c04ecbce0
commit ac9fbd5898
1 changed files with 29 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

61
README-dev
View File

@@ -9,36 +9,33 @@ This README.dev file describes the development environment.
Build system Build system
------------ ------------
This distribution uses the a GNU autotools-like build system. This is This distribution uses a GNU autotools-like build system. This is made up of a
made up of a configure script, and a Makefile. The configure script configure script, and a Makefile. The configure script detects a C23 compiler
detects a GNU compliant C compiler on the system and sets any program on the system and sets any program flags: debug, release, custom. The Makefile
flags: debug, release, custom. The Makefile builds the binary based on builds the binary based on the output [config.mak] of the configure script.
the output [config.mak] of the configure script.
Building Building
-------- --------
To build this distribution you first must run the configure script. This To build this distribution you first must run the configure script. This
outputs a config.mak file that will be used in the Make step. Then run outputs a config.mak file that will be used in the Make step. Then run make;
make; this builds the objects into build/ and the binary into bin/. this builds the objects into build/ and the binary into bin/.
Configuration Configuration
------------- -------------
The configuration script is used to generate a build intermediate step The configuration script is used to generate a build intermediate step called
called the config.mak. This file is used by the Makefile to figure out the config.mak. This file is used by the Makefile to figure out C compiler to
GNU compilant C compiler to use, what CFLAGS and LDFLAGS to use, and use, what CFLAGS and LDFLAGS to use, and where to install the binary if
where to install the binary if requested. By default these values are requested. By default these values are gcc, the release flag set, and
gcc, the release flag set, and /usr/bin/. The configuration script /usr/bin/. The configuration script supports the following flags that control
supports the following flags that control CFLAGS: --debug CFLAGS: --debug and CFLAGS="". By default, the script uses flags for a release
and CFLAGS="". By default, the script uses flags for a release build. build. Debug is for in-development programming and is the strictest when it
Debug is for in-development programming and is the strictest when it comes to warnings and other compiler output. CFLAGS="" is for custom flag
comes to warnings and other compiler output. CFLAGS="" is for custom definition. For the development environment is it recommended to use the
flag definition. For the development enviroment is it recomended to --debug flag. Some examples of how you can run the configure script:
use the --debug flag. Some examples of how you can run the configure
script:
For default behavior: For default behavior:
@@ -60,9 +57,9 @@ Makefile
-------- --------
The GNU Makefile is used to build the final executable, clean up build The GNU Makefile is used to build the final executable, clean up build
artifacts, and install the program. It checks for the config.mak which artifacts, and install the program. It checks for the config.mak which is
is generated by the configure script. For a regular build, once you have generated by the configure script. For a regular build, once you have the
the configure script with desired flags, run: configure script with desired flags, run:
make make
@@ -71,9 +68,9 @@ This builds the executable to bin/ and build objects to build/
Suggested enviroment setup Suggested enviroment setup
-------------------------- --------------------------
It is suggested that you run do the following things to prepare you It is suggested that you run do the following things to prepare you environment
enviroment for development. This is not a strict enforcment, but due for development. This is not a strict enforcement, but due to the project
to the project structure it is a good starting point. structure it is a good starting point.
git pull git pull
./tools/Cleanup ./tools/Cleanup
@@ -81,14 +78,14 @@ to the project structure it is a good starting point.
bear -- make bear -- make
./bin/yait --version ./bin/yait --version
This is to ensure that you have the most up-to-date source code, and that This is to ensure that you have the most up-to-date source code, and that there
there are no major problems with the source control version. are no major problems with the source control version.
The git pull is used to sync with the repository and prevent conflicts. The git pull is used to sync with the repository and prevent conflicts. The
The cleanup is to ensure their are no lingering build artifacts. The cleanup is to ensure their are no lingering build artifacts. The configure with
configure with debug enabled is for strict build flags and -ggdb. Bear debug enabled is for strict build flags and -ggdb. Bear is used to generated
is used to generated compile_commands.json for the clang suite of tooling. compile_commands.json for the clang suite of tooling. Finally, run the program
Finaly, run the program to ensure the chain works. to ensure the chain works.
Pre-commit checks Pre-commit checks