jeremiahkellick / jk_repo

Monorepo for C projects that may share code

jk_repo

My monorepo for various C projects that may share code

Compilation

This repo uses a lightweight, custom build program called jk_build

Quickstart

Open a terminal and change directory to the root of this repository. Run the following commands. If it works, the last one should print "Hello, world!".

Windows

.\bin\build_jk_build
.\bin\jk_build .\jk_src\learning_c\hello_world.c
.\build\hello_world

macOS/Linux

./bin/build_jk_build
./bin/jk_build ./jk_src/learning_c/hello_world.c
./build/hello_world

Prerequisites

jk_build uses MSVC on Windows and GCC on other platforms. (If you'd prefer to use a different compiler than the default on your platform, see Configuring jk_build.) This means jk_build will fail on macOS/Linux if it can't find gcc in your PATH. On Windows, it looks for cl. For cl to be found, you'll either need to run it from the correct Developer Command Prompt or execute vcvarsall.bat prior to using the command.

Building jk_build

To build jk_build, you can use the bin\build_jk_build.bat Batch script (Windows) or the bin/build_jk_build sh script (macOS/Linux). You could also simply pass jk_src/jk_build/jk_build.c to your preferred compiler.

Open a terminal and change directory to the root of this repository. Run the following command.

Windows

.\bin\build_jk_build

macOS/Linux

./bin/build_jk_build

This will produce an executable you can use to compile any other program in this repository. If you used the build_jk_build script, it will be located at the path bin/jk_build. For convenience, you might want to add the bin/ directory to your PATH.

Building other programs

A program in this repo is simply any .c or .cpp file that defines an entry point function. To build any of these programs, all you need to do is pass that file as an argument to jk_build. You don't need to pass in dependencies as arguments because jk_build will find them for you and include them when it invokes a compiler.

Build

Windows

.\bin\jk_build .\jk_src\learning_c\hello_world.c

macOS/Linux

./bin/jk_build ./jk_src/learning_c/hello_world.c

This will produce an execuable with the same name as the .c file, located in the build/ directory.

Run

Windows

.\build\hello_world

macOS/Linux

./build/hello_world

Configuring jk_build

jk_build supports one flag, -O, to enable optimizations. Other changes to compilation options should be accomplished by editing the jk_build source and rebuilding.

If you'd like to use a different compiler or change the compilation options, edit the main function at the bottom of jk_src/jk_build/jk_build.c. It simply builds up a list of command line arguments, so if you know how you'd run the compiler from the command line, it should be straightfoward to translate that into the correct jk_build code by following the existing examples for MSVC and GCC.

Once you've finished making changes, run build_jk_build again to rebuild jk_build.