diff options
| author | Baitinq <manuelpalenzuelamerino@gmail.com> | 2023-02-06 16:17:25 +0100 |
|---|---|---|
| committer | Baitinq <manuelpalenzuelamerino@gmail.com> | 2023-03-13 13:15:40 +0100 |
| commit | 038320824961c33c25d0a0c59844f792ee224471 (patch) | |
| tree | c845418b1ea47577a670720412f7af4bc6bf5a04 /README.md | |
| parent | Update (diff) | |
| download | nixos-config-new_readme.tar.gz nixos-config-new_readme.tar.bz2 nixos-config-new_readme.zip | |
Misc: Update README and documentation new_readme
Now it should be more user friendly, hopefully making it easier to install.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 93 |
1 files changed, 53 insertions, 40 deletions
diff --git a/README.md b/README.md index 46e5497..5d9d6d9 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,56 @@ # NIX Config -My Personal NixOS Flake. - - -# NixOS -## Installing - -``` -nixos-install --flake . #$HOST-$HARDWARE-$ARCH -``` - -## Updating - -``` -nix flake update - -nixos-rebuild switch --flake . #$HOST-$HARDWARE-$ARCH -``` - -# Non-Nixos -## Installing -``` -nix build .#homeManagerConfigurations.$HOST-$HARDWARE-$ARCH.activationPackage -./result/activate -``` - -## Updating -``` -nix flake update +My current (and everchanging) NixOS configuration Flake. -home-manager switch --flake .#$HOST-$HARDWARE-$ARCH -``` -# ISO -## Building -``` -nix build .#isoConfigurations.$HOST-$HARDWARE-$ARCH.config.system.build.isoImage -``` - -# Deploying -``` -# deploy -s .#$HOST-$HARDWARE-$ARCH --hostname $TARGET_IP -``` + + +## Installation +Installation steps are in [Documentation/INSTALLING.md](./Documentation/INSTALLING.md) + +## Highlights +* Multiple NixOS configurations, including desktop, laptop, and VM +* Install and partitioning scripts +* **Impermanence** +* Encrypted **BTRFS** partitions +* Secrets using **git-crypt** +* Network-deployable through **deploy-rs** +* Modularized configuration +* Wayland (*river*) and XOrg (*dwm*) desktops + +## Structure +Here is an overview of the repos' structure: +``` +. +├── flake.nix +├── flake.lock +├── modules +├── overlays +├── packages +├── secrets +├── dotfiles +├── hosts +│ ├── default.nix +│ ├── configuration.nix +│ ├── home.nix +│ ├── luna +│ └── phobos +│ ├── default.nix +│ └── home.nix +└── hardware + ├── laptop + ├── chromebook + ├── virtualbox + └── thinkpad + ├── default.nix + ├── disks.nix + └── hardware.nix +``` +* `modules`: encapsulated NixOS modules used in parts of the config +* `overlays`: nixpkgs overlays used in the config +* `packages`: extra packages used in the config +* `secrets`: git-crypt encrypted secrets used in the config +* `dotfiles`: actual dotfiles used in the config +* `hosts`: the host-specific config. Contains folders representing each host with their own specific config +* `hardware`: the hardware-specific config (eg. Disks & Partitions). Contains folders representing each hardware + +**This configuration was made to be modular and customizable; don't hesistate to adopt it and make it YOURS!** |