dream2nix/README.md

66 lines
3.4 KiB
Markdown
Raw Normal View History

2021-10-13 03:23:32 +03:00
<p align="center">
2022-11-10 00:57:48 +03:00
<picture>
2022-11-29 20:43:59 +03:00
<source width="600" media="(prefers-color-scheme: dark)" srcset="https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/0312cc4f785de36212f4303d23298f07c13549dc/dream2nix-dark.png">
2022-11-10 00:57:48 +03:00
<source width="600" media="(prefers-color-scheme: light)" srcset="https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/e2a12a60ae49aa5eb11b42775abdd1652dbe63c0/dream2nix-01.png">
<img width="600" alt="dream2nix - A framework for automated nix packaging" src="https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/e2a12a60ae49aa5eb11b42775abdd1652dbe63c0/dream2nix-01.png">
</picture>
<br>
Automate reproducible packaging for various language ecosystems
<br>
2022-11-10 00:57:48 +03:00
<a href="https://nix-community.github.io/dream2nix/">Documentation</a> |
2023-11-07 15:07:00 +03:00
<a href="https://github.com/nix-community/dream2nix/tree/main/examples/repo-with-packages">Example Repo</a> |
<a href="https://github.com/nix-community/dream2nix/tree/main/examples/repo-with-packages-flake">Example Repo Flake</a> |
<a href="https://github.com/nix-community/dream2nix/tree/main/examples/packages">Example Packages</a>
2021-10-13 03:23:32 +03:00
</p>
2024-06-11 14:59:34 +03:00
!!! 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.
2023-07-24 12:54:28 +03:00
### legacy dream2nix
2023-07-24 13:37:44 +03:00
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](https://github.com/nix-community/dream2nix/tree/legacy) of dream2nix.
2023-07-24 12:54:28 +03:00
### Funding
This project was funded through the [NGI Assure](https://nlnet.nl/assure) Fund, a fund established by [NLnet](https://nlnet.nl/) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu/) programme, under the aegis of DG Communications Networks, Content and Technology under grant agreement No 957073. **Applications are still open, you can [apply today](https://nlnet.nl/propose)**.
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.
2023-07-19 17:04:41 +03:00
### Documentation
[👉 To the docs](https://nix-community.github.io/dream2nix)
### Presentations
- [👉 2023: dream2nix based on drv-parts](https://www.youtube.com/watch?v=AsCvRZukX0E)
- [👉 2021: Original dream2nix presentation](https://www.youtube.com/watch?v=jqCfHMvCsfQ) (Examples are outdated)
### Get in touch
[👉 matrix chat room](https://matrix.to/#/#dream2nix:nixos.org)
### Contribute
[👉 GitHub repo](https://github.com/nix-community/dream2nix)
[👉 issues](https://github.com/nix-community/dream2nix/issues)
### Goals
dream2nix focuses on the following aspects:
2021-09-29 20:27:49 +03:00
- Modularity
- Customizability
- Maintainability
- Code de-duplication across 2nix solutions
- Common UI across 2nix solutions
2021-09-29 20:27:49 +03:00
- Reduce effort to develop new 2nix solutions
- Exploration and adoption of new nix features
- Simplified updating of packages
2021-09-03 18:32:00 +03:00
The goal of this project is to create a standardized, generic, modular framework for automated packaging solutions, aiming for better flexibility, maintainability and usability.
2021-09-03 18:32:00 +03:00
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.