phundrak/nix-config
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README to reflect refactor

Browse Source
This commit is contained in:
Lucien Cartier-Tilet 2025-07-31 01:00:33 +02:00
parent f396b3a8fb
commit 338246498d
1 changed files with 7 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -4,14 +4,12 @@ Personal NixOS configuration for my machines, using Nix Flakes for reproducible
## Repository Structure ## Repository Structure
- **flake.nix**: Main entry point for the Nix Flake, defining NixOS and home-manager configurations - **flake.nix**: Main entry point for the Nix Flake, defining NixOS and home-manager configurations.
- **hosts/**: Host-specific NixOS configurations - **hosts/**: Contains the host-specific NixOS configurations.
- **modules/**: Custom NixOS modules reusable across different hosts - **system/**: Holds system-wide configuration modules that can be shared across different hosts. This includes things like boot settings, desktop environments, hardware configurations, networking, packages, security, and system services.
- **programs/**: System-level programs shared across hosts - **users/**: Manages user-specific configurations. It's split into `modules` for reusable home-manager configurations and `phundrak` for my personal configuration.
- **secrets/**: Encrypted secrets managed with sops-nix - **keys/**: Public keys for various machines.
- **system/**: Common system-level configurations shared across hosts - **secrets/**: Encrypted secrets managed with `sops-nix`.
- **users/phundrak/**: Home-manager configuration for my user
- **users/modules/**: Custom user modules reusable across configurations
## Usage ## Usage
@ -51,24 +49,9 @@ nh home switch
Format Nix files (using Alejandra): Format Nix files (using Alejandra):
```bash ```bash
nix fmt nix fmt .
``` ```
## Development
For development, a devShell is provided with linting tools and git hooks:
```bash
nix develop
```
This will set up an environment with:
- alejandra (formatting)
- commitizen (commit messages)
- deadnix (dead code detection)
- statix (linting)
- Other useful git hooks
## Contributing ## Contributing
Feel free to fork this repository and make your own changes. If you have any improvements or suggestions, please open an issue or submit a pull request. Feel free to fork this repository and make your own changes. If you have any improvements or suggestions, please open an issue or submit a pull request.