Update README
This commit is contained in:
parent
9911e39f4e
commit
0237bf4245
4 changed files with 47 additions and 61 deletions
69
README.md
69
README.md
|
@ -1,21 +1,16 @@
|
||||||
# NixOS Configuration Repository
|
# NixOS Configuration Repository
|
||||||
## NOTE: These configs expect this repo to be cloned to /etc/nixos/git/
|
## NOTE: These configs expect this repo to be cloned to /etc/nixos/git/
|
||||||
### For first-run, see [setup.sh](setup.sh)
|
### For first-run, see [setup.sh](docs/setup.sh)
|
||||||
|
|
||||||
## Building
|
|
||||||
* To build the Raspberry Pi image: `nix build .#nixosConfigurations.nixos-rpi4-img.config.system.build.sdImage`
|
|
||||||
* bash alias: `nixos-build-pi-img`
|
|
||||||
* The resulting .img will be in `result/sd-image/*.img.zst`
|
|
||||||
```
|
|
||||||
6.6G nixos-sd-image-23.11.20230914.f2ea252-aarch64-linux.img
|
|
||||||
2.0G nixos-sd-image-23.11.20230914.f2ea252-aarch64-linux.img.zst
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
![Gruv'd Hyprland](./screenshot.png "Hyprland with a Gruvboxy theme")
|
![Gruv'd Hyprland](./screenshot.png "Hyprland with a Gruvboxy theme")
|
||||||
---
|
---
|
||||||
# To Do List
|
# To Do List
|
||||||
* [ ] Look into `nix develop` - [Link](https://zero-to-nix.com/concepts/nix#unified-cli)
|
* [ ] Automated ISO Creation
|
||||||
|
* Forgejo Actions
|
||||||
|
* [ ] Fix Grafana
|
||||||
|
* [x] Look into `nix develop` - [Link](https://zero-to-nix.com/concepts/nix#unified-cli)
|
||||||
* [ ] Build a better dashboard to monitor all my nixified devices
|
* [ ] Build a better dashboard to monitor all my nixified devices
|
||||||
* [ ] Look into Remote Builds - [Link](https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds.html)
|
* [ ] Look into Remote Builds - [Link](https://nixos.org/manual/nix/stable/advanced-topics/distributed-builds.html)
|
||||||
* [ ] Find a way to remove all default search engines in Firefox (Google, Amazon, etc)
|
* [ ] Find a way to remove all default search engines in Firefox (Google, Amazon, etc)
|
||||||
|
@ -27,12 +22,12 @@
|
||||||
* [ ] emacs
|
* [ ] emacs
|
||||||
* [ ] Add bracket auto-completion
|
* [ ] Add bracket auto-completion
|
||||||
* [ ] Find a way to have magit save login credentials
|
* [ ] Find a way to have magit save login credentials
|
||||||
* [ ] Try disko - [Link](https://github.com/nix-community/disko)
|
* [x] Try disko - [Link](https://github.com/nix-community/disko)
|
||||||
* [ ] btrfs snapshots
|
* [ ] btrfs snapshots
|
||||||
* [ ] vscodium and user-config.js file?
|
* [ ] vscodium and user-config.js file?
|
||||||
* [ ] rofi - bitwarden-cli / bitwarden-menu ([Link](https://search.nixos.org/packages?channel=23.05&show=bitwarden-menu&from=0&size=50&sort=relevance&type=packages&query=bitwarden))
|
* [ ] rofi - bitwarden-cli / bitwarden-menu ([Link](https://search.nixos.org/packages?channel=23.05&show=bitwarden-menu&from=0&size=50&sort=relevance&type=packages&query=bitwarden))
|
||||||
|
|
||||||
Completed ToDo List [here](complete.md)
|
Completed ToDo List [here](docs/complete.md)
|
||||||
---
|
---
|
||||||
|
|
||||||
# Directory Structure
|
# Directory Structure
|
||||||
|
@ -96,14 +91,6 @@ Completed ToDo List [here](complete.md)
|
||||||
└── gruvbox
|
└── gruvbox
|
||||||
```
|
```
|
||||||
|
|
||||||
# Configs
|
|
||||||
| Hostname | Description | Status |
|
|
||||||
| -------- | ----------- | ------ |
|
|
||||||
| nixos-laptop | Lenovo P1 Gen 5 | Complete |
|
|
||||||
| nixos-framework | Intel Framework 13 | Awaiting Hardware |
|
|
||||||
| nixos-rpi4-01 | Testing Raspberry Pi / ARM | In Work |
|
|
||||||
| nixos-vm-01 | VM for building images | In Work |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Information
|
# Information
|
||||||
|
@ -133,47 +120,7 @@ Completed ToDo List [here](complete.md)
|
||||||
|
|
||||||
---
|
---
|
||||||
# Theming
|
# Theming
|
||||||
| Name | Description | Desktops | Status |
|
* To change system-wide themes, see [theming.md](docs/theming.md))
|
||||||
| ---- | ----------- | -------- | ------ |
|
|
||||||
| default | No theming applied | All | Complete |
|
|
||||||
| gruvbox | Fall / Retro groovy theme | Hyprland/Gnome | Hyprland Complete, Gnome WIP |
|
|
||||||
| synth | Synthwave / Cyberpunk theme | Hyprland/Gnome | Work in Progress |
|
|
||||||
|
|
||||||
* To change system-wide themes, you need to change the following:
|
|
||||||
|
|
||||||
## Desktops
|
|
||||||
### gnome
|
|
||||||
1. `nixos/common/desktops/gnome/default.nix` - Change the imports at the bottom.
|
|
||||||
2. `home-manager/hosts/$HOSTNAME/desktops/gnome-conf.nix` - Change the variables at the top.
|
|
||||||
### hyprland
|
|
||||||
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/hyprland-conf.nix` - Change the `WALLPAPER_DIR` variable in `".config/hypr/start.sh".text`
|
|
||||||
2. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/hyprland-conf.nix` - Change `col.active_border` and `col.inactive_border` in the `general` section.
|
|
||||||
3. `home-manager/bash.nix` - Update the `sessionVariable` variable `GTK_THEME`
|
|
||||||
|
|
||||||
## Software
|
|
||||||
### waybar
|
|
||||||
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/waybar-conf.nix` - Update all relevant colors. Possibly make configs for colorschemes and import them.
|
|
||||||
### swaylock
|
|
||||||
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/swaylock-conf.nix` - Update all relevant colors. Possibly make configs for colorschemes and import them.
|
|
||||||
### kitty
|
|
||||||
1. `home-manager/common/software/cli/kitty.nix` - Update the content of `home.file.".config/kitty/theme.conf".text`
|
|
||||||
### Firefox
|
|
||||||
1. `home-manager/common/software/gui/firefox.nix` - Change the entry under "# Theming"
|
|
||||||
### btop
|
|
||||||
1. `home-manager/common/software/cli/btop.nix` - Set `color_theme`
|
|
||||||
### bash / powerline
|
|
||||||
1. `home-manager/common/software/cli/bash.nix` - Set `theme` in `programs.powerline-go.settings`
|
|
||||||
### neofetch
|
|
||||||
1. `home-manager/common/software/cli/neofetch.nix` - Update the contents of `home.file.".config/neofetch/config.conf".text`
|
|
||||||
### wlogout
|
|
||||||
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/wlogout.nix` - Update the `style.css` section
|
|
||||||
|
|
||||||
## Text Editors
|
|
||||||
### emacs
|
|
||||||
1. `home-manager/common/software/cli/doom-emacs.d/packages.el` - Include your theme here, if needed
|
|
||||||
2. `home-manager/common/software/cli/doom-emacs.d/config.el` - Set your theme here `(setq doom-theme '$THEME_NAME)`
|
|
||||||
### neovim
|
|
||||||
1. Theming done within vim itself `<SPC> t h`
|
|
||||||
|
|
||||||
---
|
---
|
||||||
# GPG Keys
|
# GPG Keys
|
||||||
|
|
39
docs/theming.md
Normal file
39
docs/theming.md
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
| Name | Description | Desktops | Status |
|
||||||
|
| ---- | ----------- | -------- | ------ |
|
||||||
|
| default | No theming applied | All | Complete |
|
||||||
|
| gruvbox | Fall / Retro groovy theme | Hyprland/Gnome | Hyprland Complete, Gnome WIP |
|
||||||
|
| synth | Synthwave / Cyberpunk theme | Hyprland/Gnome | Work in Progress |
|
||||||
|
|
||||||
|
## Desktops
|
||||||
|
### gnome
|
||||||
|
1. `nixos/common/desktops/gnome/default.nix` - Change the imports at the bottom.
|
||||||
|
2. `home-manager/hosts/$HOSTNAME/desktops/gnome-conf.nix` - Change the variables at the top.
|
||||||
|
### hyprland
|
||||||
|
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/hyprland-conf.nix` - Change the `WALLPAPER_DIR` variable in `".config/hypr/start.sh".text`
|
||||||
|
2. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/hyprland-conf.nix` - Change `col.active_border` and `col.inactive_border` in the `general` section.
|
||||||
|
3. `home-manager/bash.nix` - Update the `sessionVariable` variable `GTK_THEME`
|
||||||
|
|
||||||
|
## Software
|
||||||
|
### waybar
|
||||||
|
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/waybar-conf.nix` - Update all relevant colors. Possibly make configs for colorschemes and import them.
|
||||||
|
### swaylock
|
||||||
|
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/swaylock-conf.nix` - Update all relevant colors. Possibly make configs for colorschemes and import them.
|
||||||
|
### kitty
|
||||||
|
1. `home-manager/common/software/cli/kitty.nix` - Update the content of `home.file.".config/kitty/theme.conf".text`
|
||||||
|
### Firefox
|
||||||
|
1. `home-manager/common/software/gui/firefox.nix` - Change the entry under "# Theming"
|
||||||
|
### btop
|
||||||
|
1. `home-manager/common/software/cli/btop.nix` - Set `color_theme`
|
||||||
|
### bash / powerline
|
||||||
|
1. `home-manager/common/software/cli/bash.nix` - Set `theme` in `programs.powerline-go.settings`
|
||||||
|
### neofetch
|
||||||
|
1. `home-manager/common/software/cli/neofetch.nix` - Update the contents of `home.file.".config/neofetch/config.conf".text`
|
||||||
|
### wlogout
|
||||||
|
1. `home-manager/hosts/$HOSTNAME/desktops/hyprland/$THEME/wlogout.nix` - Update the `style.css` section
|
||||||
|
|
||||||
|
## Text Editors
|
||||||
|
### emacs
|
||||||
|
1. `home-manager/common/software/cli/doom-emacs.d/packages.el` - Include your theme here, if needed
|
||||||
|
2. `home-manager/common/software/cli/doom-emacs.d/config.el` - Set your theme here `(setq doom-theme '$THEME_NAME)`
|
||||||
|
### neovim
|
||||||
|
1. Theming done within vim itself `<SPC> t h`
|
Loading…
Reference in a new issue