Update README.md

This commit is contained in:
pagedMov
2024-11-06 15:04:57 -05:00
committed by GitHub
parent 2d71f92f80
commit c40e4d0c88

View File

@@ -23,6 +23,18 @@ Screenshots up to date as of [this commit](https://github.com/pagedMov/nixos-con
| Text Editor | [Nixvim](https://github.com/nix-community/nixvim) | | Text Editor | [Nixvim](https://github.com/nix-community/nixvim) |
| Image Viewer | [feh](https://github.com/derf/feh) | | Image Viewer | [feh](https://github.com/derf/feh) |
## Installation
If you are on NixOS and have flakes enabled, you can just follow these steps:
1. Clone the repo to a directory
2. Run nixos-generate-config --show-hardware-config > hardware.nix to get a hardware config
3. Move the hardware config to the folder of the host you want to use
4. Run sudo nixos-rebuild switch --flake /path/to/flake#host where "host" is the name of the config you want to use
## Configs ## Configs
Currently there are two complete system configurations available. These are: Currently there are two complete system configurations available. These are:
@@ -37,18 +49,6 @@ The 'Xenon' config is my server configuration and is highly unlikely to be of us
This config uses custom modules for the home-manager and system configurations. Basically every part of the configuration can be toggled using an option, and some configs have extra options as well. This config uses custom modules for the home-manager and system configurations. Basically every part of the configuration can be toggled using an option, and some configs have extra options as well.
All of the options declared in these modules can be found in the documentation under docs/options All of the options declared in these modules can be found in the documentation under docs/options
## Installation
If you are on NixOS and have flakes enabled, you can just follow these steps:
1. Clone the repo to a directory
2. Run nixos-generate-config --show-hardware-config > hardware.nix to get a hardware config
3. Move the hardware config to the folder of the host you want to use
4. Run sudo nixos-rebuild switch --flake /path/to/flake#host where "host" is the name of the config you want to use
## Scripts ## Scripts
```chpaper``` - opens a fzf window with filenames and previews of images in $FLAKEPATH/assets/wallpapers. Picking one replaces the existing wallpaper path in $FLAKEPATH/flake.nix with the one you chose. ```chpaper``` - opens a fzf window with filenames and previews of images in $FLAKEPATH/assets/wallpapers. Picking one replaces the existing wallpaper path in $FLAKEPATH/flake.nix with the one you chose.