Daholli/nixos-config
1
0
Fork 0
Code Issues 5 Pull requests Actions Packages Releases Activity

chore: update documentation

Browse source
This commit is contained in:
Christoph Hollizeck 2024-10-13 12:06:21 +02:00
parent 0620f758d6
commit 3fde505c6c
4 changed files with 34 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -35,7 +35,7 @@ Luckily for me Jake (the creator of snowfall-lib) was so kind and helped me bugf
### homes
The homes folder is home to all your homemanager configuration that is specific to that system (and user) and that system only.
If you want generic home manager configuration then look into [modules/home](moddules/home/README.md).
If you want generic home manager configuration then look into [modules/home](modules/home/README.md).
- home/system/user@hostname syntax

11
modules/README.md
View file

@ -1,11 +1,14 @@
## Modules Part of the Flake
### [nixos](./nixos/README.md)
## [nixos](./nixos/README.md)
All the system configuration should go in here
### [home](./home/README.md)
## [home](./home/README.md)
All the home-manager configuration should go in here
## [darwin](./darwin/README.md)
> [!NOTE]
> I currently do not own a mac so I have not set up a mac specific configuration

1
modules/home/README.md Normal file
View file

@ -0,0 +1 @@
# Home-manager configuration

27
modules/nixos/README.md
View file

@ -1,27 +1,50 @@
# System Configuration
# System configuration
## apps
These contain specialized configurations some simple some more complex to enable programs and everything around them.
This section also has a subsection `cli-apps` which is exclusively for apps that live in your terminal.
## [archetypes](./archetypes/README.md)
This section contains configurations that enable whole system types at once, check out the more in depth Readme in that section
Planned archetypes are:
- gaming (this is mostly fleshed out since I use it on my main machine)
- wsl
- pi
- minimal-server
- github runner?
## [desktop](./desktop/README.md)
This section contains everything related to GUI
This section contains everything related to GUI.
currently I am using Hyprland, but I was using more or less out of the box KDE for a long time and was very happy with it.
It also has a `addons` section where I plan to put all configurations for things of the hyprland ecosystem and bars such as waybar / ags (in the future).
## security
This has some of the configuration you need for your system to run properly, gpg has the yubikey configuration, the keyring is well a keyring, so that your computer can access the TPM, and also [sops-nix](https://github.com/Mic92/sops-nix) which I would recommend to setup for critical information.
## services
This section is fairly empty, but will be filled up when I start with the server configs.
## [submodules](./submodules/README.md)
This is the smaller archetypes section, just to combine some aspects that are never used alone into one package, such as the basic one that activates all the mandatory things I don't want to write out every time.
## system
This section is home to all of the low level system related configuration, it contains sections for your hardware, keyboard layouts what boot attributes to set, and which fonts to install.
## tools
This section could also be part of the cli-apps section but I want to have more system critical things here e.g Git and direnv both amazing tools that deserve a special spot in this config.
## user
Here you define the user, or I guess users if you have more people using this system, I will think about multi user systems when I need to :D