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