README.md

<!--
SPDX-FileCopyrightText: 2026 Dipl. Phys. Peer Stritzinger GmbH

SPDX-License-Identifier: Apache-2.0
-->

rebar_calzone
=====

Rebar3 plugin for packaging escripts as Calzone binaries.

Build
-----

    $ rebar3 compile

Use
---

Add the plugin to your rebar config:

    {plugins, [
        {rebar_calzone, "1.0.0"}
    ]}.

Commands
-------

### Calzone

Run the `calzone` command in an existing escript project:

    $ rebar3 calzone

The generated output file is named:

    <escript-name>-<os>-<arch>.bin

Requirements
------------

The `baker` and `launcher` executables must be available on `PATH`.

Config
------

Configure `rebar_calzone` in `rebar.config`:

    {rebar_calzone, [
        {mode, escript}
    ]}.

Currently only `escript` mode is supported.