dream2nix/README.md
2024-07-29 10:37:19 +00:00

3.4 KiB

dream2nix - A framework for automated nix packaging
Automate reproducible packaging for various language ecosystems
Documentation | Example Repo | Example Repo Flake | Example Packages

!!! warning

dream2nix is unstable software. While simple UX is one of our main focus points, the APIs  are still under development. Do expect changes that will break your setup.

legacy dream2nix

Dream2nix is currently in the process of being refactored to make use of drv-parts. Not all features and subsystems are migrated yet. If you prefer continue using the makeFlakeOutputs interface, please refer to the legacy branch of dream2nix.

Funding

This project was funded through the NGI Assure Fund, a fund established by NLnet with financial support from the European Commission's Next Generation Internet programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 957073. Applications are still open, you can apply today.

If your organization wants to support the project with extra funding in order to add support for more languages or new features, please contact one of the maintainers.

Documentation

👉 To the docs

Presentations

Get in touch

👉 matrix chat room

Contribute

👉 GitHub repo

👉 issues

Goals

dream2nix focuses on the following aspects:

  • Modularity
  • Customizability
  • Maintainability
  • Code de-duplication across 2nix solutions
  • Common UI across 2nix solutions
  • Reduce effort to develop new 2nix solutions
  • Exploration and adoption of new nix features
  • Simplified updating of packages

The goal of this project is to create a standardized, generic, modular framework for automated packaging solutions, aiming for better flexibility, maintainability and usability.

The intention is to integrate many existing 2nix converters into this framework, thereby improving many of the previously named aspects and providing a unified UX for all 2nix solutions.