foodogsquared/nixos-config
1
0
Fork 0
mirror of https://github.com/foo-dogsquared/nixos-config.git synced 2025-01-31 04:58:01 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

docs: update project setup notes

Browse Source 
With the right configuration alongside system
This commit is contained in:
Gabriel Arazas 2023-06-22 18:04:02 +08:00
parent ff3dd9d3f7
commit 4e23ffa6c4
No known key found for this signature in database
GPG Key ID: ADE0C41DAB221FCC
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.adoc
View File

@ -92,7 +92,7 @@ As a helpful summary, here's what my flake should contain sorting from the most
* `overlays` contains the overlay for extending nixpkgs with my packages. * `overlays` contains the overlay for extending nixpkgs with my packages.
If you want to use my packages alongside the nixpkgs attribute then this is what you're looking for. If you want to use my packages alongside the nixpkgs attribute then this is what you're looking for.
* `homeManagerModules` are where my link:./modules/home-manager[custom home-manager modules] to be exported. * `homeModules` are where my link:./modules/home-manager[custom home-manager modules] to be exported.
footnote:[This is more useful than my NixOS modules.] footnote:[This is more useful than my NixOS modules.]
* `nixosModules` are composed from NixOS modules defined in link:./modules/nixos[`./modules/nixos`]. * `nixosModules` are composed from NixOS modules defined in link:./modules/nixos[`./modules/nixos`].
@ -110,7 +110,7 @@ A few examples include:
* `devShells` from link:./shells/[my custom environments]. * `devShells` from link:./shells/[my custom environments].
Similar to `homeManagerConfigurations`, you can easily use it outside of NixOS. Similar to `homeManagerConfigurations`, you can easily use it outside of NixOS.
* `homeManagerConfigurations` contains my various link:https://github.com/nix-community/home-manager[home-manager] configurations from link:./users/home-manager/[`./users/home-manager/`]. * `homeConfigurations` contains my various link:https://github.com/nix-community/home-manager[home-manager] configurations from link:./users/home-manager/[`./users/home-manager/`].
The neat thing about it is you can easily install it in a non-NixOS Linux distro. The neat thing about it is you can easily install it in a non-NixOS Linux distro.
* `deploy` are nodes to be deployed by link:https://github.com/serokell/deploy-rs[deploy-rs]. * `deploy` are nodes to be deployed by link:https://github.com/serokell/deploy-rs[deploy-rs].
@ -195,9 +195,14 @@ nixos-config
├── default.nix ├── default.nix
├── flake.lock ├── flake.lock
├── flake.nix ├── flake.nix
├── images.toml
└── README.adoc └── README.adoc
---- ----
One of the more notable files here when first start looking is the link:./images.toml[`./images.toml`] file where it contains a description of the images.
The data is then used for certain functions in the flake definition file (i.e., `flake.nix`).
The data can contain from what image output format it is intended to be deployed (most likely used anyways), the nixpkgs channel to be used, and its system (e.g., `x86_64-linux`).
Most of the said folders are related to a flake output attribute, see <<whats-in-my-flake>> for more details. Most of the said folders are related to a flake output attribute, see <<whats-in-my-flake>> for more details.
* link:./hosts/[`./hosts/`] contain machine-specific configuration. * link:./hosts/[`./hosts/`] contain machine-specific configuration.