diff --git a/.github/README.md b/.github/README.md index f1c0637..16e4df3 100644 --- a/.github/README.md +++ b/.github/README.md @@ -15,6 +15,8 @@ - [Security](#security) - [My Dots](#my-dots) - [Setup](#setup) + - [Directory Structure](#directory-structure) + - [Configuring](#configuring) - [Aliases](#aliases) - [Utilities](#utilities) - [Packages](#packages) @@ -191,6 +193,23 @@ Once the repo is cloned, you can modify whatever files you like before running t --- + +### Directory Structure + +
+~
+└── .
+    ├── bash/
+    ├── tmux/
+    ├── vim/
+    ├── zsh/
+    ├── .github/
+    ├── lets-go.sh
+    └── install.sh
+
+ +--- + ### Configuring The locations for all symlinks are defined in [`.install.conf.yaml`](https://github.com/Lissy93/dotfiles/blob/master/.install.conf.yaml). These are managed using [Dotbot](https://github.com/anishathalye/dotbot), and will be applied whenever you run the [`install.sh`](https://github.com/Lissy93/dotfiles/blob/master/install.sh) script. The symlinks set locations based on XDG paths, all of which are defined in [`.zshenv`](https://github.com/Lissy93/dotfiles/blob/master/zsh/.zshenv).