dream2nix/README.md

<p align="center">
  <picture>
    <source width="600" media="(prefers-color-scheme: dark)" srcset="https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/0312cc4f785de36212f4303d23298f07c13549dc/dream2nix-dark.png">
    <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>
  <a href="https://nix-community.github.io/dream2nix/">Documentation</a> |
  <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>
</p>

!!! 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](https://github.com/nix-community/dream2nix/tree/legacy) of dream2nix.

### 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.

### 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:

- 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.
add dream2nix logo 2021-10-13 03:23:32 +03:00			`<p align="center">`
add stats for ecosystems to readme 2022-11-10 00:57:48 +03:00			`<picture>`
chore: add dark logo to readme 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">`
add stats for ecosystems to readme 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>`
docs: acknowledge funding more - Move funding section to the top of the readme - add funding paragraph to the intro of the docs 2022-12-15 10:04:37 +03:00			`Automate reproducible packaging for various language ecosystems`
			`<br>`
add stats for ecosystems to readme 2022-11-10 00:57:48 +03:00			`<a href="https://nix-community.github.io/dream2nix/">Documentation</a> \|`
examples: rename repo examples 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> \|`
docs(readme): fix example links and add one for flake repo 2023-09-05 21:14:34 +03:00			`<a href="https://github.com/nix-community/dream2nix/tree/main/examples/packages">Example Packages</a>`
add dream2nix logo 2021-10-13 03:23:32 +03:00			`</p>`

fix admonition (mkdocs syntax) 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.`
docs: acknowledge funding more - Move funding section to the top of the readme - add funding paragraph to the intro of the docs 2022-12-15 10:04:37 +03:00
WIP (#598) 2023-07-24 12:54:28 +03:00			`### legacy dream2nix`

readme: fix typo 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.
WIP (#598) 2023-07-24 12:54:28 +03:00
docs: acknowledge funding more - Move funding section to the top of the readme - add funding paragraph to the intro of the docs 2022-12-15 10:04:37 +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).`
python improvements, docs and guide. - add warning to readme and docs stating that dream2nix is unstable software - refactor structure of docs: remove title .md pages, instead add titles via (# title) to SUMMARY - change order of doc topics. move `guides` and `subsystems` to the front - add docs for python subsystem - add getting started guide for python - extend ./examples/python to make use of translator options - add new function to dlib `systemsFromFile` that allows to load the `supportedSystems` from a file. This alows changing the supported systems without touching the flake. - move pip translator args to extra file `args.nix` to allow embedding in docs - fix pip translator - add a .gitignore to the basic flake template - use new systemsFromFile function in basic flake template 2022-07-16 16:03:16 +03:00
docs: acknowledge funding more - Move funding section to the top of the readme - add funding paragraph to the intro of the docs 2022-12-15 10:04:37 +03:00			`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.`

docs: improve readme 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`
docs: acknowledge funding more - Move funding section to the top of the readme - add funding paragraph to the intro of the docs 2022-12-15 10:04:37 +03:00
			`dream2nix focuses on the following aspects:`
docs: improve readme + nixpkgs section 2021-09-29 20:27:49 +03:00
			`- Modularity`
			`- Customizability`
			`- Maintainability`
readme: cleanup, improve, remove legacy stuff 2023-07-18 13:42:48 +03:00			`- Code de-duplication across 2nix solutions`
			`- Common UI across 2nix solutions`
docs: improve readme + nixpkgs section 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`
init 2021-09-03 18:32:00 +03:00
docs(readme): update docs cli app instructions, fix formatting 2022-06-21 19:11:02 +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.`
init 2021-09-03 18:32:00 +03:00
docs(readme): update docs cli app instructions, fix formatting 2022-06-21 19:11:02 +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.`