Skip to content

Commit

Permalink
docs: improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tiborpilz committed Apr 5, 2024
1 parent 23fb47b commit 2f92b94
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,16 @@

This is my NixOS and Home Manager configuration, which I use on my personal computer. NixOS is a Linux distribution that uses the Nix package manager, and Home Manager is a Nix-based configuration management tool for configuring the user environment. This configuration uses the new Flakes feature in Nix to provide a more modular and flexible way of managing the configuration.

## Layout

This project uses Nix Flakes to manage the configurations. You can read more about Flakes [here](https://wiki.nixos.org/wiki/Flakes).

The Flake has outputs for my Hosts (as NixOS or Nix Darwin) configurations and my Home Manager configurations. The `hosts` directory contains the NixOS and Nix Darwin configurations, and the `home` directory contains the Home Manager configurations.

For reproducibility, I'm using modules defined in the `modules` directory for my hosts and `home/modules` for my Home Manager configuration.

To automatically inject the modules into the configuration, I'm using custom functions defined in `lib`.

## CI

### Garnix
Expand Down

0 comments on commit 2f92b94

Please sign in to comment.