nezia/flocon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

repo: update README (explain configuration and minor fixes)

Browse source
This commit is contained in:
Anthony Rodriguez 2024-10-22 02:00:07 +02:00
parent af3c8ebd8c
commit 0511bf4efd
Signed by: nezia
GPG key ID: EE3BE97C040A86CE
1 changed files with 17 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -14,13 +14,22 @@ Additionally using a lot of other software you can find in the configuration fil
# 🛠️ Structure # 🛠️ Structure
| Name | Description | | Name | Description |
| ------------------- | ------------------------------------------------- | | ------------------- | -------------------------- |
| [home](home/) | Home manager configuration | | [home](home/) | Home manager configuration |
| [hosts](hosts/) | Host-specific (entry-points of the configuration) | | [hosts](hosts/) | Host-specific |
| [lib](lib/) | Helper functions | | [lib](lib/) | Helper functions |
| [modules](modules/) | NixOS modules | | [modules](modules/) | NixOS modules |
| [system](system/) | NixOS configuration | | [system](system/) | NixOS configuration |
My configuration is structured based on the following principles:
1. Hosts should be the main entry points and outputs.
2. Abstractions should be avoided as much as possible.
The bulk of the configuration can be found either in [home](home/) or [system](system/), which declares most of my programs, with some extra Nix code in [lib](lib/) and custom [modules](modules/), mostly for convenience and to provide a way to globally set styles and themes for now.
My hosts can then pick and choose the programs and configurations that they need from the other directories. If the need arises for a more modular setup for a specific piece of software (ie. having different flavors of Firefox per host), I will write a custom module for it. This helps to avoid unnecessarily abstracting my configuration, as I don't find it necessary for the most part, and I would also like it to remain as simple as possible.
# 👥 Credits # 👥 Credits
@ -29,4 +38,4 @@ People / repositories I have copied / learned from:
- [fufexan/dotfiles](https://github.com/fufexan/dotfiles) for the configuration structure - [fufexan/dotfiles](https://github.com/fufexan/dotfiles) for the configuration structure
- [jacekpoz/nixos](https://git.jacekpoz.pl/poz/niksos) for learning how NixOS modules work - [jacekpoz/nixos](https://git.jacekpoz.pl/poz/niksos) for learning how NixOS modules work
Some bits have also been borrowed from within the configuration, and credit has been given when its due. Some bits have also been borrowed from within the configuration, and credit has been given where its due.