From ab284c7f6218409d2af016dc45221420ddfe98c8 Mon Sep 17 00:00:00 2001 From: Simon Cornet Date: Sun, 24 Mar 2024 17:51:29 +0100 Subject: [PATCH] [docs] added install, upkeep and usage sections --- docs/install/readme.md | 85 ++++++++++++++++++++++++++++++++++ docs/upkeep/readme.md | 10 ++++ docs/usage/readme.md | 89 ++++++++++++++++++++++++++++++++++++ readme.md | 101 ++--------------------------------------- 4 files changed, 189 insertions(+), 96 deletions(-) create mode 100644 docs/install/readme.md create mode 100644 docs/upkeep/readme.md create mode 100644 docs/usage/readme.md diff --git a/docs/install/readme.md b/docs/install/readme.md new file mode 100644 index 0000000..3e6b153 --- /dev/null +++ b/docs/install/readme.md @@ -0,0 +1,85 @@ +base: [NixOS 23.11](https://channels.nixos.org/nixos-23.11/latest-nixos-minimal-x86_64-linux.iso) + +This will install nix using the following disk layout. +| mountpoint | filesystem | partition | size | +|------------| ---------- | --------- | -------- | +| /boot | fat32 | /dev/sda1 | 500MB | +| / | ext4 | /dev/sda2 | the rest | + +Make sure to use the correct disk. 😊 + +## Installation +``` +nix-shell -p git +``` + +Partitions +``` +g (gpt disk label) +n +1 (partition number [1/128]) +2048 first sector ++500M last sector (boot sector size) +t +1 (EFI System) +n +2 +default (fill up partition) +default (fill up partition) +w (write) +``` + +Filesystems +``` +sudo mkfs.fat -F 32 /dev/sda1 +sudo mkfs.ext4 /dev/sda2 -L root +sudo fatlabel /dev/sda1 boot +sudo mount /dev/disk/by-label/root /mnt +sudo mkdir -p /mnt/boot +sudo mount /dev/disk/by-label/boot /mnt/boot +``` + +Clone this repo +``` +git clone https://git.simoncor.net/siempie/dotfiles-nix.git +``` + +Start Installation +``` +cd dotfiles +sudo nixos-install --flake ./dotfiles-nix# +``` + +Reboot +``` +sudo reboot +``` + + +## Finalize +Clone dotfiles +``` +git clone https://git.simoncor.net/siempie/dotfiles-nix.git ~/.dotfiles +``` + +Hyprland +``` +mkdir -p ~/.config/hypr +rm -rf ~/.config/hypr/hyprland +ln -s ~/.dotfiles/hyprland/hyprland.conf ~/.config/hypr/hyprland.conf +``` + +Login to all apps +``` +bitwarden +firefox + bitwarden plugin +google-chrome + bitwarden -plugin +nextcloud +vscode +spotify +``` + +Headscale +``` +sudo tailscale up --login-server=https://vpn.mirahsimon.us:443 --accept-routes --operator=$USER +``` diff --git a/docs/upkeep/readme.md b/docs/upkeep/readme.md new file mode 100644 index 0000000..d2fe933 --- /dev/null +++ b/docs/upkeep/readme.md @@ -0,0 +1,10 @@ +## maintenance +system rebuild +``` +sudo nixos-rebuild switch --upgrade --flake ~/.dotfiles# +``` + +firmware updates +``` +sudo fwupdmgr update +``` diff --git a/docs/usage/readme.md b/docs/usage/readme.md new file mode 100644 index 0000000..1b7745c --- /dev/null +++ b/docs/usage/readme.md @@ -0,0 +1,89 @@ +# Usage + +## Applications +| | | +|--------------------------| -------------------------------------- | +| **Application Launcher** | Wofi | +| **Bar** | Waybar | +| **Browsers** | Firefox, Google Chrome, Microsoft Edge | +| **Clipboard Manager** | clipse | +| **Desktop Environment** | Gnome, Hyprland (primary) | +| **Display Server** | Wayland | +| **File Manager** | Nautilus | +| **Image Viewer** | Loupe | +| **Image Editor** | GIMP | +| **Music Player** | Spotify | +| **Shell** | zsh | +| **Password Manager** | Bitwarden | +| **Terminal Emulator** | Alacritty | +| **Text Editors** | vim, Visual Studio Code | +| **Video Player** | mpv | +| **VPN Client** | Tailscale | + +Other usefull utilities: + - git + - imagemagick + - meld + - nextcloud-client + - solaar + - sshfs + +## Hyprland +#### Keyboard bindings + +`mainMod = SUPER` + +| applications | | +| -------------| -------------------- | +| mM + enter | terminal | +| mM + C | clipboard manager | +| mM + D | application launcher | +| mM + E | file manager | +| mM + L | lock screen | +| mM + S | take screenshot | + + +| focus | | +| ---------- | ---------------- | +| mM + up | move focus up | +| mM + down | move focus down | +| mM + left | move focus left | +| mM + right | move focus right | + + +| window control | | +| ----------------- | ----------------- | +| mM + F | window fullscreen | +| mM + J | toggle split | +| mM + P | toggle pseudo | +| mM + Q | window close | +| mM + V | toggle float | +| mM + mouse_right | move window | +| mM + mouse_left | resize window | +| ALT SHIFT + up | move window up | +| ALT SHIFT + down | move window down | +| ALT SHIFT + left | move window left | +| ALT SHIFT + right | move window right | + + +| workspace | | +| --------------------- | ------------------------------- | +| mM + 0-9 | move focus to workspace 0-9 | +| mM + SHIFT + 0-9 | move window to workspace 0-9 | +| mM + mouse_wheel_up | move focus to previous workspace | +| mM + mouse_wheel_down | move focus to next workspace | + + +#### Autostart (in order) + - waybar + - tailscale + - clipse + - blueman-tray + - solaar + - nextcloud-desktop + - bitwarden (workspace 1) + - firefox (workspace 2) + - alacritty (workspace 3) + +## Theme +TODO diff --git a/readme.md b/readme.md index d76f194..5ce4257 100644 --- a/readme.md +++ b/readme.md @@ -1,99 +1,8 @@ # NixOS configuration for siempie -base: NixOS 23.11 -## Phase 1: Installation (minimal ISO) -``` -nix-shell -p git -``` +# Documentation +[Install](https://git.simoncor.net/dotfiles-nix/docs/install) +[Upkeep](https://git.simoncor.net/dotfiles-nix/docs/upkeep) +[Usage](https://git.simoncor.net/dotfiles-nix/docs/usage) -Create partitions -``` -g (gpt disk label) -n -1 (partition number [1/128]) -2048 first sector -+500M last sector (boot sector size) -t -1 (EFI System) -n -2 -default (fill up partition) -default (fill up partition) -w (write) -``` - -Labels and filesystems -``` -sudo mkfs.fat -F 32 /dev/sda1 -sudo mkfs.ext4 /dev/sda2 -L root -sudo fatlabel /dev/sda1 boot -sudo mount /dev/disk/by-label/root /mnt -sudo mkdir -p /mnt/boot -sudo mount /dev/disk/by-label/boot /mnt/boot -``` - -Clone dotfiles repo -``` -git clone https://git.simoncor.net/siempie/dotfiles-nix.git -``` - -Nix installation -``` -cd dotfiles -sudo nixos-install --flake .# -``` - -Reboot -``` -sudo reboot -``` - - -## Phase 2: Finalize -Clone dotfiles -``` -git clone https://git.simoncor.net/siempie/dotfiles-nix.git ~/.dotfiles -``` - -Link Hyprland -``` -rm -rf ~/.config/hypr/hyprland -ln -s ~/.dotfiles/hyprland/hyprland.conf ~/.config/hypr/hyprland.conf -``` - -Login to apps -``` -bitwarden -firefox + bitwarden plugin -google-chrome + bitwarden -plugin -nextcloud -vscode -spotify -``` - -Set avatar for GDM -``` -! dont forget ! -``` - -Tailscale -``` -sudo tailscale up --login-server=https://vpn.mirahsimon.us:443 --accept-routes --operator=$USER -``` - -SSH keys -``` -! dont forget ! -``` - - -## Phase 3: Maintenance -Rebuild after changes -``` -sudo nixos-rebuild switch --upgrade --flake ~/.dotfiles# -``` - -Regularly update firmware -``` -sudo fwupdmgr update -``` +Enjoy!