From b9113a193581850ba5003e489992f4c2462e420f Mon Sep 17 00:00:00 2001 From: DavHau Date: Wed, 19 Jul 2023 16:04:41 +0200 Subject: [PATCH] docs: improve readme --- README.md | 35 +++++++++++++++++++------------- docs/src/intro.md | 51 +---------------------------------------------- 2 files changed, 22 insertions(+), 64 deletions(-) mode change 100644 => 120000 docs/src/intro.md diff --git a/README.md b/README.md index 85c2e58e78..a690354dc7 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,27 @@ This project was funded through the [NGI Assure](https://nlnet.nl/assure) Fund, 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. -## Goals +### 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: @@ -35,16 +55,3 @@ dream2nix focuses on the following aspects: 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 - -[👉 To the docs](https://nix-community.github.io/dream2nix) - -### Presentations - -- [👉 2021: Original dream2nix presentation](https://www.youtube.com/watch?v=jqCfHMvCsfQ) - Examples are outdated: -- [👉 2023: dream2nix based on drv-parts](hhttps://www.youtube.com/watch?v=AsCvRZukX0E) - Examples are outdated: - -### Community - -[👉 matrix chat room](https://matrix.to/#/#dream2nix:nixos.org) diff --git a/docs/src/intro.md b/docs/src/intro.md deleted file mode 100644 index 85c2e58e78..0000000000 --- a/docs/src/intro.md +++ /dev/null @@ -1,50 +0,0 @@ -

- - - - dream2nix - A framework for automated nix packaging - -
- Automate reproducible packaging for various language ecosystems -
- Documentation | - Examples -

- -!!! 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. - -### 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. - -## 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. - -### Documentation - -[👉 To the docs](https://nix-community.github.io/dream2nix) - -### Presentations - -- [👉 2021: Original dream2nix presentation](https://www.youtube.com/watch?v=jqCfHMvCsfQ) - Examples are outdated: -- [👉 2023: dream2nix based on drv-parts](hhttps://www.youtube.com/watch?v=AsCvRZukX0E) - Examples are outdated: - -### Community - -[👉 matrix chat room](https://matrix.to/#/#dream2nix:nixos.org) diff --git a/docs/src/intro.md b/docs/src/intro.md new file mode 120000 index 0000000000..fe84005413 --- /dev/null +++ b/docs/src/intro.md @@ -0,0 +1 @@ +../../README.md \ No newline at end of file