DEVELOPMENT.md

OVERVIEW

tinyrick's own compilation process is compatible with standard cargo. We wrap some common workflows with build tasks for convenience.

BUILDTIME REQUIREMENTS

• Docker 20.10.21+
• GNU / BSD make
• Rust 1.75.0+
• POSIX compatible sh
• 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)
• cargo-cache
• direnv 2
• a UNIX environment, such as macOS, Linux, BSD, WSL, etc.

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

INSTALL BINARY ARTIFACTS FROM LOCAL SOURCE

$ make install

UNINSTALL BINARY ARTIFACTS

$ make uninstall

AUDIT

$ make audit

BUILD: LINT, DOC, COMPILE, and TEST

$ make build

PUBLISH

$ make publish

PORT

$ make port

CLEAN

$ make clean