From 3b7772712e672a451ec60aa5fe677a7bd370e4de Mon Sep 17 00:00:00 2001 From: Ryan Yin Date: Tue, 5 Dec 2023 11:18:15 +0800 Subject: [PATCH] docs: update README --- README.md | 48 ++++++++++++++++++++++++++---------------------- 1 file changed, 26 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 475cb25d..bff223b8 100644 --- a/README.md +++ b/README.md @@ -26,27 +26,29 @@ Nix allows for easy-to-manage, collaborative, reproducible deployments. This mea ## Components -| | NixOS(Wayland) | NixOS(Xorg) | -| --------------------------- | :--------------------------------------------------------------------------------------------- | :------------------------------------------------------ | -| **Window Manager** | [Hyprland][Hyprland] | [i3][i3] | -| **Terminal Emulator** | [Kitty][Kitty] | [Kitty][Kitty] | -| **Bar** | [Waybar][Waybar] | [i3block][i3block] | -| **Application Launcher** | [anyrun][anyrun] | [rofi][rofi] | -| **Notification Daemon** | [Mako][Mako] | [Dunst][Dunst] | -| **Display Manager** | [GDM][GDM] | [GDM][GDM] | -| **Color Scheme** | [Catppuccin][Catppuccin] | [Catppuccin][Catppuccin] | -| **network management tool** | [NetworkManager][NetworkManager] | [NetworkManager][NetworkManager] | -| **Input method framework** | [Fcitx5][Fcitx5] | [Fcitx5][Fcitx5] | -| **System resource monitor** | [Btop][Btop] | [Btop][Btop] | -| **File Manager** | [ranger][ranger] + [thunar][thunar] | [ranger][ranger] + [thunar][thunar] | -| **Shell** | [Nushell][Nushell] + [Starship][Starship] | [Nushell][Nushell] + [Starship][Starship] | -| **Music Player** | [mpd][mpd], [ncmpcpp][ncmpcpp], [mpc][mpc], [Netease-cloud-music-gtk][netease-cloud-music-gtk] | [Netease-cloud-music-gtk][netease-cloud-music-gtk] | -| **Media Player** | [mpv][mpv] | [mpv][mpv] | -| **Text Editor** | [Neovim][Neovim] | [Neovim][Neovim] | -| **Fonts** | [Nerd fonts][Nerd fonts] | [Nerd fonts][Nerd fonts] | -| **Image Viewer** | [imv][imv] | [imv][imv] | -| **Screenshot Software** | [grim][grim] | [flameshot](https://github.com/flameshot-org/flameshot) | -| **Screen Recording** | [OBS][OBS] | [OBS][OBS] | +| | NixOS(Wayland) | NixOS(Xorg) | +| --------------------------- | :---------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------- | +| **Window Manager** | [Hyprland][Hyprland] | [i3][i3] | +| **Terminal Emulator** | [Kitty][Kitty] | [Kitty][Kitty] | +| **Bar** | [Waybar][Waybar] | [i3block][i3block] | +| **Application Launcher** | [anyrun][anyrun] | [rofi][rofi] | +| **Notification Daemon** | [Mako][Mako] | [Dunst][Dunst] | +| **Display Manager** | [GDM][GDM] | [GDM][GDM] | +| **Color Scheme** | [Catppuccin][Catppuccin] | [Catppuccin][Catppuccin] | +| **network management tool** | [NetworkManager][NetworkManager] | [NetworkManager][NetworkManager] | +| **Input method framework** | [Fcitx5][Fcitx5] | [Fcitx5][Fcitx5] | +| **System resource monitor** | [Btop][Btop] | [Btop][Btop] | +| **File Manager** | [ranger][ranger] + [thunar][thunar] | [ranger][ranger] + [thunar][thunar] | +| **Shell** | [Nushell][Nushell] + [Starship][Starship] | [Nushell][Nushell] + [Starship][Starship] | +| **Music Player** | [mpd][mpd], [ncmpcpp][ncmpcpp], [mpc][mpc], [Netease-cloud-music-gtk][netease-cloud-music-gtk] | [Netease-cloud-music-gtk][netease-cloud-music-gtk] | +| **Media Player** | [mpv][mpv] | [mpv][mpv] | +| **Text Editor** | [Neovim][Neovim] | [Neovim][Neovim] | +| **Fonts** | [Nerd fonts][Nerd fonts] | [Nerd fonts][Nerd fonts] | +| **Image Viewer** | [imv][imv] | [imv][imv] | +| **Screenshot Software** | [grim][grim] | [flameshot](https://github.com/flameshot-org/flameshot) | +| **Screen Recording** | [OBS][OBS] | [OBS][OBS] | +| **Filesystem & Encryption** | tmpfs on `/`, [Btrfs][Btrfs] subvolumes on a [LUKS][LUKS] crypted partition for persistent, unlock via passphrase | tmpfs on `/`, [Btrfs][Btrfs] subvolumes on a [LUKS][LUKS] crypted partition for persistent, unlock via passphrase | +| **Secure Boot** | [lanzaboote][lanzaboote] | [lanzaboote][lanzaboote] | Wallpapers: https://github.com/ryan4yin/wallpapers @@ -69,7 +71,6 @@ See [./home/base/desktop/neovim](./home/base/desktop/neovim) for details. See [./hosts](./hosts) for details. - ## Secrets Management See [./secrets](./secrets) for details. @@ -213,3 +214,6 @@ Other dotfiles that inspired me: [thunar]: https://gitlab.xfce.org/xfce/thunar [ranger]: https://github.com/ranger/ranger [Catppuccin]: https://github.com/catppuccin/catppuccin +[Btrfs]: https://btrfs.readthedocs.io +[LUKS]: https://wiki.archlinux.org/title/Dm-crypt/Encrypting_an_entire_system +[lanzaboote]: https://github.com/nix-community/lanzaboote