dream2nix/README.md

<p align="center">
<img width="400" src="https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/e2a12a60ae49aa5eb11b42775abdd1652dbe63c0/dream2nix-01.png">
</p>

## dream2nix - A framework for automated nix packaging

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

Jump to:
- [Quick Start](https://nix-community.github.io/dream2nix/guides/quick-start.html)
- [Documentation](https://nix-community.github.io/dream2nix)

dream2nix is a framework for automatically converting packages from other build systems to nix.

It focuses on the following aspects:

- Modularity
- Customizability
- Maintainability
- Nixpkgs Compatibility, by not enforcing IFD (import from derivation)
- Code de-duplication across 2nix converters
- Code de-duplication in nixpkgs
- Risk-free opt-in aggregated fetching (larger [FODs](https://nixos.wiki/wiki/Glossary), less checksums)
- Common UI across 2nix converters
- 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.

### Documentation

Documentation can be found at [nix-community.github.io/dream2nix](https://nix-community.github.io/dream2nix).

The documentation is also available in your terminal inside the dream2nix dev shell via `d2n-docs [keyword]` or by running:  
`nix run github:nix-community/dream2nix#docs [keyword]`
### Funding

This project receives financial support by [NLNet](https://nlnet.nl/) as part of the [NGI Assure Programme](https://nlnet.nl/assure/) funded by the European Commission.

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.

### Community

matrix: https://matrix.to/#/#dream2nix:nixos.org

### Watch the presentation

(The code examples of the presentation are outdated)
[![dream2nix - A generic framework for 2nix tools](https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/3c8b2c56f5fca3bf5c343ffc179136eef39d4d6a/dream2nix-youtube-talk.png)](https://www.youtube.com/watch?v=jqCfHMvCsfQ)
add dream2nix logo 2021-10-13 03:23:32 +03:00			`<p align="center">`
add video presentation + refactor readme 2021-10-15 19:39:35 +03:00			`<img width="400" src="https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/e2a12a60ae49aa5eb11b42775abdd1652dbe63c0/dream2nix-01.png">`
add dream2nix logo 2021-10-13 03:23:32 +03:00			`</p>`

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			`## dream2nix - A framework for automated nix packaging`

			`!!! 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: improve readme + nixpkgs section 2021-09-29 20:27:49 +03:00
refactor: readme/docs The motivation of this change is to trim down the github front page (README.md). Code examples should not be part of that page. It should be short and only contain the most important information that's necessary for a rough overview. - add sections `Quick Start` and `Presentation ...` to docs - move usage examples from readme to `Quick Start` in the docs - trim down the explanation about `Documentation` a bit - move the youtube presentation to the end - 2022-07-17 22:17:41 +03:00			`Jump to:`
			`- [Quick Start](https://nix-community.github.io/dream2nix/guides/quick-start.html)`
			`- [Documentation](https://nix-community.github.io/dream2nix)`

docs(readme): update docs cli app instructions, fix formatting 2022-06-21 19:11:02 +03:00			`dream2nix is a framework for automatically converting packages from other build systems to nix.`
docs: setup mdbook book for documentation, add CLI app for docs (#173) * docs: setup mdbook book for documentation * ci: add github action for docs * docs: add a cli command for showing docs in terminal * Update docs/src/subsystems/rust.md Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> * docs(rust): add example for crane overriding * docs: add a further reading section to intro * docs: fix a few links * docs(readme): move documentation section up and fit some sections into 80 columns Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> 2022-06-13 22:27:05 +03:00
init 2021-09-03 18:32:00 +03:00			`It focuses on the following aspects:`
docs: improve readme + nixpkgs section 2021-09-29 20:27:49 +03:00
			`- Modularity`
			`- Customizability`
			`- Maintainability`
update readme: wording, glossary fixes #132 2022-05-03 23:33:08 +03:00			`- Nixpkgs Compatibility, by not enforcing IFD (import from derivation)`
docs: improve readme + nixpkgs section 2021-09-29 20:27:49 +03:00			`- Code de-duplication across 2nix converters`
			`- Code de-duplication in nixpkgs`
update readme: wording, glossary fixes #132 2022-05-03 23:33:08 +03:00			`- Risk-free opt-in aggregated fetching (larger [FODs](https://nixos.wiki/wiki/Glossary), less checksums)`
docs: improve readme + nixpkgs section 2021-09-29 20:27:49 +03:00			`- Common UI across 2nix converters`
			`- 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.`
update readme/docs/schemas 2021-09-07 00:49:40 +03:00
docs: setup mdbook book for documentation, add CLI app for docs (#173) * docs: setup mdbook book for documentation * ci: add github action for docs * docs: add a cli command for showing docs in terminal * Update docs/src/subsystems/rust.md Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> * docs(rust): add example for crane overriding * docs: add a further reading section to intro * docs: fix a few links * docs(readme): move documentation section up and fit some sections into 80 columns Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> 2022-06-13 22:27:05 +03:00			`### Documentation`

refactor: readme/docs The motivation of this change is to trim down the github front page (README.md). Code examples should not be part of that page. It should be short and only contain the most important information that's necessary for a rough overview. - add sections `Quick Start` and `Presentation ...` to docs - move usage examples from readme to `Quick Start` in the docs - trim down the explanation about `Documentation` a bit - move the youtube presentation to the end - 2022-07-17 22:17:41 +03:00			`Documentation can be found at [nix-community.github.io/dream2nix](https://nix-community.github.io/dream2nix).`
add video presentation + refactor readme 2021-10-15 19:39:35 +03:00
refactor: readme/docs The motivation of this change is to trim down the github front page (README.md). Code examples should not be part of that page. It should be short and only contain the most important information that's necessary for a rough overview. - add sections `Quick Start` and `Presentation ...` to docs - move usage examples from readme to `Quick Start` in the docs - trim down the explanation about `Documentation` a bit - move the youtube presentation to the end - 2022-07-17 22:17:41 +03:00			The documentation is also available in your terminal inside the dream2nix dev shell via `d2n-docs [keyword]` or by running:
			`nix run github:nix-community/dream2nix#docs [keyword]`
readme: ad section funding 2022-05-15 20:04:07 +03:00			`### Funding`

docs(readme): update docs cli app instructions, fix formatting 2022-06-21 19:11:02 +03:00			`This project receives financial support by [NLNet](https://nlnet.nl/) as part of the [NGI Assure Programme](https://nlnet.nl/assure/) funded by the European Commission.`
docs: setup mdbook book for documentation, add CLI app for docs (#173) * docs: setup mdbook book for documentation * ci: add github action for docs * docs: add a cli command for showing docs in terminal * Update docs/src/subsystems/rust.md Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> * docs(rust): add example for crane overriding * docs: add a further reading section to intro * docs: fix a few links * docs(readme): move documentation section up and fit some sections into 80 columns Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> 2022-06-13 22:27:05 +03:00
Fix typos in documentation 2022-07-14 12:31:44 +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.`
readme: ad section funding 2022-05-15 20:04:07 +03:00
add matrix link to readme 2022-03-12 17:07:27 +03:00			`### Community`
docs: setup mdbook book for documentation, add CLI app for docs (#173) * docs: setup mdbook book for documentation * ci: add github action for docs * docs: add a cli command for showing docs in terminal * Update docs/src/subsystems/rust.md Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> * docs(rust): add example for crane overriding * docs: add a further reading section to intro * docs: fix a few links * docs(readme): move documentation section up and fit some sections into 80 columns Co-authored-by: Ilan Joselevich <personal@ilanjoselevich.com> 2022-06-13 22:27:05 +03:00
add matrix link to readme 2022-03-12 17:07:27 +03:00			`matrix: https://matrix.to/#/#dream2nix:nixos.org`

refactor: readme/docs The motivation of this change is to trim down the github front page (README.md). Code examples should not be part of that page. It should be short and only contain the most important information that's necessary for a rough overview. - add sections `Quick Start` and `Presentation ...` to docs - move usage examples from readme to `Quick Start` in the docs - trim down the explanation about `Documentation` a bit - move the youtube presentation to the end - 2022-07-17 22:17:41 +03:00			`### Watch the presentation`

			`(The code examples of the presentation are outdated)`
			`[![dream2nix - A generic framework for 2nix tools](https://gist.githubusercontent.com/DavHau/755fed3774e89c0b9b8953a0a25309fa/raw/3c8b2c56f5fca3bf5c343ffc179136eef39d4d6a/dream2nix-youtube-talk.png)](https://www.youtube.com/watch?v=jqCfHMvCsfQ)`