瀏覽代碼

docs: describe repository contents

All commits *before* this one are "pseudo-commits", which represent a
ficticiously clean history of the repository.
Joe 1 年之前
父節點
當前提交
eafb95a603
共有 1 個文件被更改,包括 76 次插入2 次删除
  1. 76 2
      .github/README.md

+ 76 - 2
.github/README.md

@@ -13,6 +13,20 @@ cloning this repository into your home directory probably won't get you
 anywhere, but poking around and pilfering interesting snippets could turn out to
 be a great use of your time.
 
+<details open>
+<summary>Some highlights of this repository are:</summary>
+
+- [JonathanDarker (`~/.config/jonathandarker/`)](./.config/jonathandarker/):
+  Color scheme inspired by JetBrain's Darcula.
+- [Neovim Config (`~/.config/nvim/`)](./.config/nvim/): Lua-based and
+  plugin-light configuration for Neovim.
+- [Surfingkeys Config (`~/.config/surfingkeys/`)](./.config/surfingkeys/):
+  TypeScript-based configuration for Surfingkeys.
+
+</details>
+
+<details>
+
 The contents of the repository is described below:
 
 <table frame="void">
@@ -29,8 +43,6 @@ OpenGL terminal emulator.
 Package list for [Homebrew](https://brew.sh/), the missing package manager for
 MacOS. See the subdirectory's [README.md](./.config/brew/README.md) for details.
 
-</td>
-<td>
 ### [git (`~/.config/git/`)](./.config/git/)
 
 Configuration for [Git](https://git-scm.com/docs/), a free and open source
@@ -91,5 +103,67 @@ use.
 
 </td>
 <td>
+
+```mermaid
+graph TB
+    macOS["`**macOS**`"]
+    macOS --- Applications
+    macOS --- WindowManager
+    macOS --- PackageManager
+    subgraph PackageManager [Package Manager]
+        brew["`**Homebrew**
+                macOS package manager`"]
+    end
+    subgraph WindowManager [Window Manager]
+        yabai["`**yabai**
+                 yabai tiles windows and
+                 controls desktop spaces`"]
+        skhd["`**skhd**
+                 skhd handles OS-level
+                 hotkeys, mostly for yabai
+                 and app switching`"]
+    end
+    WindowManager-- "`*displays*`" ---Applications
+    subgraph Applications
+        direction LR
+        subgraph Terminal
+            direction TB
+            Alacritty["`**Alacritty**
+                        Terminal emulator, used
+                        almost only for multiplexer`"]
+            Alacritty-- "`*renders*`" ---Multiplexer
+            subgraph Multiplexer
+                direction TB
+                tmux["`**tmux**
+                       Multiplexer used almost
+                       only for session managment`"]
+                tmux-- "`*sessionizes*`" ---Editor
+                tmux-- "`*sessionizes*`" ---Shell
+                subgraph Editor
+                    Neovim["`**Neovim**
+                             Text editor and file explorer
+                             that serves as a de-facto
+                             terminal operating system`"]
+                end
+                Neovim-- "`*emulates*`" ---Shell
+                subgraph Shell
+                    Zsh["`**Zsh**
+                          Modern (and macOS-default) shell`"]
+                end
+            end
+        end
+        subgraph Browser
+            chromium["`**ungoogled-chromium**
+                       Google-free Chrome fork`"]
+            chromium-- "`*uses*`" ---Extensions
+            subgraph Extensions
+                surfingkeys["`**Surfingkeys**
+                              Customizable extension for
+                              mouse-free browsing`"]
+            end
+        end
+    end
+```
+
 </td>
 </tr></tbody></table>