<!--
SPDX-FileCopyrightText: 2025 Ruby Iris Juric <ruby@srxl.me>

SPDX-License-Identifier: 0BSD
-->

# gleam2nix

[![latest release](https://git.isincredibly.gay/srxl/gleam2nix/badges/release.svg)](https://git.isincredibly.gay/srxl/gleam2nix/releases/latest)
[![free of syn](https://img.shields.io/badge/free%20of-syn-hotpink)](https://github.com/fasterthanlime/free-of-syn)
![trans rights](https://pride-badges.pony.workers.dev/static/v1?label=trans%20rights&stripeWidth=6&stripeColors=5BCEFA,F5A9B8,FFFFFF,F5A9B8,5BCEFA)

tools for building [gleam](https://gleam.run) projects with [nix](https://nixos.org).

see the [documentation website](https://gleam2nix.foxgirl.engineering/) for more info.

## roadmap

- [x] build targeting the BEAM
  - [x] `gleam export erlang-shipment` style packaging
  - [ ] OTP releases
  - [ ] escript packaging?
- [ ] build targeting JS
  - [ ] nodejs
  - [ ] deno
  - [ ] bun
- [ ] upstream to nixpkgs
  - [ ] `gleam2nix` cli
  - [ ] builder functions

## contributing

the canonical home of this repo is on my [personal git forge](https://git.isincredibly.gay/srxl/gleam2nix), which doesn't have open signups. if you want to submit some changes or report bugs, you can either:

- open issues/PRs on the [tangled mirror](https://tangled.org/@foxgirl.engineering/gleam2nix)
- send me an email at `ruby@srxl.me` with issue reports or git patches

## licensing

all code in this repo is available under the very permissive terms of the [zero-clause bsd](./LICENSES/0BSD.txt) license.