From 06f1b2c75453748f3afb10772c5bedb0ba2a23f9 Mon Sep 17 00:00:00 2001 From: yunfachi Date: Mon, 30 Sep 2024 15:52:33 +0300 Subject: [PATCH] README: init --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9522542..cf022cf 100644 --- a/README.md +++ b/README.md @@ -1 +1,33 @@ -# Denix \ No newline at end of file +# Denix + +Denix is a Nix library designed to help you build scalable configurations for [NixOS](https://nixos.org/) and [Home Manager](https://github.com/nix-community/home-manager). + +## Documentation + +You can find the documentation here: [Denix Documentation](https://yunfachi.github.io/denix/introduction) + +## Key Features + +### Modular System +Custom modules allow you to define options and related configurations in a flexible way, simplifying the management of your entire system. + +### Hosts and Rices +* **Hosts**: Unique configurations tailored for each machine. +* **Rices**: Customizations that can be applied to all hosts. + +### Unified NixOS and Home Manager Configurations +Write your NixOS and Home Manager configurations in a single file*, and Denix will automatically handle the separation for you. + +## Templates + +### [minimal](./templates/minimal/) (recommended) +Hosts, rices, and initial modules for quick setup: +```sh +nix flake init -t github:yunfachi/denix#minimal +``` + +### [minimal-no-rices](./templates/minimal-no-rices/) +Hosts and initial modules without rices: +```sh +nix flake init -t github:yunfachi/denix#minimal-no-rices +```