HASH 49c951c87766
DATE 2025-02-01
SUBJECT docs: readme
FILES 1 CHANGED
HASH 49c951c87766
DATE 2025-02-01
SUBJECT docs: readme
FILES 1 CHANGED
┌─ README.md ────────────────────────────────────────────────────────────────┐│ diff --git a/README.md b/README.md ││ index f26b6b0..8a6bb0d 100644 ││ --- a/README.md ││ +++ b/README.md ││ @@ -3,23 +3,17 @@ ││ ││ ## Overview ││ ││ -This repository serves two main purposes: ││ - ││ -1. To serve as a centralized location for all my personal computing ││ - infrastructure ││ -2. To provide a place to experiment and learn about networking, administration, ││ - security, unix, design, and programming ││ +The goals of this repository are: ││ +1. To maintain a centralized location for all my personal computing infrastructur ││ e ││ +2. To provide a place to experiment and learn about networking, administration, s ││ ecurity, unix, design, and programming ││ ││ > [!WARNING] ││ -> This repository is not intended to be used by anyone but myself. It is highly ││ -> personalized and likely doesn't fit anyone else's needs. I leave this ││ -> repository public to serve as a reference for anyone else building something ││ -> similar. ││ +> This repository is not intended to be used by anyone but myself. It is highly p ││ ersonalized and likely doesn't fit anyone else's needs. I maintain this repository ││ publicly as a reference for anyone building something similar. ││ ││ ## Features ││ ││ - NixOS configurations for all my hosts ││ -- Home-manager configuration for my workstations ││ +- Home-Manager configuration for my workstations ││ - Custom packages ││ - Development environments ││ - Declarative secrets with agenix ││ @@ -46,12 +40,10 @@ As this project serves as a learning environment, its architec ││ ture changes ││ frequently. While I'll try to keep this documentation current, what follows is a ││ high-level overview of the current design. ││ ││ -One of the main goals of this project was to allow for easy bootstrapping of new ││ -hosts while maintaining fine-grained configuration on a per-host basis. This is ││ -accomplished using a roles and profiles pattern (similar to ││ -[Puppet's roles and profiles method](https://www.puppet.com/docs/puppet/7/the_rol ││ es_and_profiles_method.html)). ││ +The current architecture enables straightfoward bootstrapping of new hosts while ││ maintaining fine-grained configuration on a per-host basis. This is accomplished u ││ sing a roles and profiles pattern (similar to [Puppet's roles and profiles method] ││ (https://www.puppet.com/docs/puppet/7/the_roles_and_profiles_method.html)). ││ + ││ ││ -#### Roles ││ +### Roles ││ ││ - **Workstation**: Desktop/laptop systems with GUI environment ││ - **Server**: Headless systems running specific services ││ @@ -85,7 +77,7 @@ flake.nixosConfigurations = { ││ }; ││ ``` ││ ││ -#### Profiles ││ +### Profiles ││ ││ Profiles are collections of related software and configurations that can be ││ enabled on a per-host basis. Here are some example profiles for workstations: ││ @@ -97,7 +89,7 @@ enabled on a per-host basis. Here are some example profiles for ││ workstations: ││ - `media`: Audio/video playback and management ││ - `virtualization`: Virtual machine support ││ ││ -Example configuration: ││ +Example: ││ ││ ```nix ││ ooknet.workstation.profiles = ["gaming" "creative" "media"]; ││ @@ -116,16 +108,17 @@ ooknet.server.services = ["ookflix"]; ││ ## Desktop environment ││ ││ <img src=".github/assets/2025-01-26T21:52:48,481278761+11:00.png" /> ││ -All workstations currently run a minimal wayland configuration made from a few ││ +All workstations use a minimal wayland configuration made from the following ││ components: ││ ││ -- [Hyprland](https://github.com/hyprwm/Hyprland) ││ -- Hypr* ware ([hypridle](https://github.com/hyprwm/hypridle), ││ - [hyprlock](https://github.com/hyprwm/hyprlock), ││ - [hyprpaper](https://github.com/hyprwm/hyprpaper)) ││ -- [Waybar](https://github.com/Alexays/Waybar) ││ -- [Mako](https://github.com/emersion/mako) ││ -- [Gruvbox extended](https://github.com/ooks-io/ooknet/blob/main/outputs/hozen/de ││ fault.nix) ││ +- **Compositor**: [Hyprland](https://github.com/hyprwm/Hyprland) ││ +- **Utilities**: ││ + - **Idle**: [hypridle](https://github.com/hyprwm/hypridle) ││ + - **Screen locker**: [hyprlock](https://github.com/hyprwm/hyprlock) ││ + - **Wallpaper**: [hyprpaper](https://github.com/hyprwm/hyprpaper) ││ + - **Bar**: [Waybar](https://github.com/Alexays/Waybar) ││ + - **Notifications**: [Mako](https://github.com/emersion/mako) ││ +- **Colorscheme**: [Gruvbox extended](https://github.com/ooks-io/ooknet/blob/main ││ /outputs/hozen/default.nix) ││ ││ ## Appreciation ││ │└────────────────────────────────────────────────────────────────────────────────────┘
┌─ README.md ──────────────────────────┐│ diff --git a/README.md b/README.md ││ index f26b6b0..8a6bb0d 100644 ││ --- a/README.md ││ +++ b/README.md ││ @@ -3,23 +3,17 @@ ││ ││ ## Overview ││ ││ -This repository serves two main purposes: ││ - ││ -1. To serve as a centralized location for a ││ ll my personal computing ││ - infrastructure ││ -2. To provide a place to experiment and lea ││ rn about networking, administration, ││ - security, unix, design, and programming ││ +The goals of this repository are: ││ +1. To maintain a centralized location for a ││ ll my personal computing infrastructure ││ +2. To provide a place to experiment and lea ││ rn about networking, administration, securit ││ y, unix, design, and programming ││ ││ > [!WARNING] ││ -> This repository is not intended to be use ││ d by anyone but myself. It is highly ││ -> personalized and likely doesn't fit anyon ││ e else's needs. I leave this ││ -> repository public to serve as a reference ││ for anyone else building something ││ -> similar. ││ +> This repository is not intended to be use ││ d by anyone but myself. It is highly persona ││ lized and likely doesn't fit anyone else's n ││ eeds. I maintain this repository publicly as ││ a reference for anyone building something s ││ imilar. ││ ││ ## Features ││ ││ - NixOS configurations for all my hosts ││ -- Home-manager configuration for my worksta ││ tions ││ +- Home-Manager configuration for my worksta ││ tions ││ - Custom packages ││ - Development environments ││ - Declarative secrets with agenix ││ @@ -46,12 +40,10 @@ As this project serves a ││ s a learning environment, its architecture c ││ hanges ││ frequently. While I'll try to keep this doc ││ umentation current, what follows is a ││ high-level overview of the current design. ││ ││ -One of the main goals of this project was t ││ o allow for easy bootstrapping of new ││ -hosts while maintaining fine-grained config ││ uration on a per-host basis. This is ││ -accomplished using a roles and profiles pat ││ tern (similar to ││ -[Puppet's roles and profiles method](https: ││ //www.puppet.com/docs/puppet/7/the_roles_and ││ _profiles_method.html)). ││ +The current architecture enables straightfo ││ ward bootstrapping of new hosts while mainta ││ ining fine-grained configuration on a per-ho ││ st basis. This is accomplished using a roles ││ and profiles pattern (similar to [Puppet's ││ roles and profiles method](https://www.puppe ││ t.com/docs/puppet/7/the_roles_and_profiles_m ││ ethod.html)). ││ + ││ ││ -#### Roles ││ +### Roles ││ ││ - **Workstation**: Desktop/laptop systems w ││ ith GUI environment ││ - **Server**: Headless systems running spec ││ ific services ││ @@ -85,7 +77,7 @@ flake.nixosConfigurations ││ = { ││ }; ││ ``` ││ ││ -#### Profiles ││ +### Profiles ││ ││ Profiles are collections of related softwar ││ e and configurations that can be ││ enabled on a per-host basis. Here are some ││ example profiles for workstations: ││ @@ -97,7 +89,7 @@ enabled on a per-host basi ││ s. Here are some example profiles for workst ││ ations: ││ - `media`: Audio/video playback and managem ││ ent ││ - `virtualization`: Virtual machine support ││ ││ -Example configuration: ││ +Example: ││ ││ ```nix ││ ooknet.workstation.profiles = ["gaming" "cr ││ eative" "media"]; ││ @@ -116,16 +108,17 @@ ooknet.server.services ││ = ["ookflix"]; ││ ## Desktop environment ││ ││ <img src=".github/assets/2025-01-26T21:52:4 ││ 8,481278761+11:00.png" /> ││ -All workstations currently run a minimal wa ││ yland configuration made from a few ││ +All workstations use a minimal wayland conf ││ iguration made from the following ││ components: ││ ││ -- [Hyprland](https://github.com/hyprwm/Hypr ││ land) ││ -- Hypr* ware ([hypridle](https://github.com ││ /hyprwm/hypridle), ││ - [hyprlock](https://github.com/hyprwm/hypr ││ lock), ││ - [hyprpaper](https://github.com/hyprwm/hyp ││ rpaper)) ││ -- [Waybar](https://github.com/Alexays/Wayba ││ r) ││ -- [Mako](https://github.com/emersion/mako) ││ -- [Gruvbox extended](https://github.com/ook ││ s-io/ooknet/blob/main/outputs/hozen/default. ││ nix) ││ +- **Compositor**: [Hyprland](https://github ││ .com/hyprwm/Hyprland) ││ +- **Utilities**: ││ + - **Idle**: [hypridle](https://github.co ││ m/hyprwm/hypridle) ││ + - **Screen locker**: [hyprlock](https:// ││ github.com/hyprwm/hyprlock) ││ + - **Wallpaper**: [hyprpaper](https://git ││ hub.com/hyprwm/hyprpaper) ││ + - **Bar**: [Waybar](https://github.com/A ││ lexays/Waybar) ││ + - **Notifications**: [Mako](https://gith ││ ub.com/emersion/mako) ││ +- **Colorscheme**: [Gruvbox extended](https ││ ://github.com/ooks-io/ooknet/blob/main/outpu ││ ts/hozen/default.nix) ││ ││ ## Appreciation ││ │└──────────────────────────────────────────────┘