Add layout to README

This commit is contained in:
caem 2025-02-01 13:41:19 +01:00
parent 1a84f59a5b
commit ad8f9bafa1
Signed by: caem
GPG key ID: 69A830D03203405F

View file

@ -1,14 +1,44 @@
# caenix
# caenix
## Screenshot
![Screenshot of my desktop](assets/screenshot.png)
## Layout
Work in progress.
```
.
├── .gitattributes
├── .gitignore
├── README.md
├── assets ; Binary assets such as screenshots and wallpapers
│ └── ...
├── flake.lock
├── flake.nix
├── hosts ; Host configurations
│ ├── puter
│ │ ├── default.nix ; Host specific configuration options
│ │ ├── disko.nix ; Host specific partitioning layout
│ │ └── packages.nix ; Host specific package set
│ └── ...
├── install.sh
├── lib ; Custom helper functions
│ └── ...
├── modules ; Configuration modules
│ ├── home ; Home-manager modules
│ │ └── caem ; User home-manager modules
│ │ ├── default.nix ; User specific configuration options
│ │ ├── packages.nix ; User specific package set
│ │ └── ...
│ └── nixos ; NixOS modules
│ ├── user ; User definition
│ │ └── caem.nix
│ └── ...
└── overlays ; Overlays
└── ...
```
## Installation
### Setting up your secrets repository
### Setting up your secrets repository
This step is required to install the system as it is built around nix-sops
with encrypted files in a private repository in order to not expose even the