About

Build automation tool

• Inspired by make
• No automatic targets[^one]
• Minimalist functionality; maximalist readability
• Configuration is a simple Markdown file named [Makefile.md]
• Processes the target(s) specified or if none, processes the first target
• Commands are run via sh shell
• If any command fails (exits with a non-zero code), processing halts immediately

Syntax

• A Level 1 heading begins the definition of a target.
• A plain text target name is a "phony" target and will always run.[^two]
• A code span target name is a file target and will only run if any dependency file target's modification time is newer than the target.[^two]
• An unordered list contains the target's dependencies.
• A code block contains the commands that are run when the target is processed.
• Commands may use the following variables:
  • {0}: first dependency
  • {target}: target name

See [Makefile.md] for an example.

Usage

$ mkrs -V
mkrs 0.1.0

$ mkrs -h
Build automation tool

Usage: mkrs [OPTIONS] [NAME]...

Arguments:
  [NAME]...  Target(s)

Options:
  -l             List available targets
  -n             Dry run
  -h, --help     Print help
  -V, --version  Print version

[^one]: Unlike make, mkrs does not have any built-in knowledge about how to compile any sort of file; all such commands must be defined in the configuration file.

[^two]: A target of either sort is only processed if it is a dependency of the target(s) that are being processed.