DEVELOPMENT.md

BUILDTIME REQUIREMENTS

• clang++ 14+ or g++ 12+
• cmake 3.8+
• cppcheck 2.10+
• Docker 20.10.12+
• Doxygen 9.4+
• Docker 20.10.12+
• GNU / BSD make
• Python 3.12.1+
• Rust 1.75.0+
• snek 0.0.5
• Snyk
• POSIX compatible tar
• Provision additional dev tools with make -j 4 -f install.mk

Recommended

• a host capable of running musl/Linux containers (e.g. a GNU/Linux, musl/Linux, macOS, or Windows host)
• Docker First Aid Kit
• Apply DOCKER_DEFAULT_PLATFORM = linux/amd64 environment variable
• ASDF 0.10 (run asdf reshim after provisioning)
• clang-format
• clang-tidy (macOS: brew install llvm, then brew link llvm --force)
• direnv 2
• macOS open or equivalent alias
• POSIX compatible tar
• tree
• a UNIX environment, such as macOS, Linux, BSD, WSL, etc.

Non-UNIX environments may produce subtle adverse effects when linting or generating application ports.

AUDIT

$ make audit

BUILD

$ make [build]

INSTALL

$ make install

UNINSTALL

$ make uninstall

LINT

$ make lint

DOCUMENT

$ make doc
$ open html/index.html

PORT

$ make port

CLEAN

$ make clean