[CHORE] updated readme

This commit is contained in:
Daveanand Mannie
2025-08-10 00:44:14 -04:00
parent cdf613ad8a
commit 84a367f1bf
3 changed files with 66 additions and 28 deletions

View File

@@ -1,6 +1,8 @@
# 💤 LazyVim Config # 💤 LazyVim Config
This is my personal **LazyVim** configuration, designed to run seamlessly on both **WSL (Windows)** and **bare-metal Linux** environments. It also integrates cleanly with external tools like `wezterm` and `lsd`. This is my personal **LazyVim** configuration, designed to run seamlessly on both
**WSL (Windows)** and **bare-metal Linux** environments. It also integrates
cleanly with external tools like `wezterm` and `lsd`.
--- ---
@@ -11,23 +13,57 @@ This is my personal **LazyVim** configuration, designed to run seamlessly on bot
| `main` | Windows (via WSL) | Tuned for WSL-specific enhancements | | `main` | Windows (via WSL) | Tuned for WSL-specific enhancements |
| `linux` | Native Linux system | Designed for full Linux installations | | `linux` | Native Linux system | Designed for full Linux installations |
> 🔁 Switch branches depending on your platform. Each has slight differences in environment assumptions and plugin behavior. > 🔁 Switch branches depending on your platform. Each has slight differences in
environment assumptions and plugin behavior.
--- ---
## 🔗 External Config Links ## 🔗 External Config Links
Some external tool configurations live in the **parent directory** of this repo. Youll need to **symlink or hard link** them into the appropriate locations: Some external tool configurations live in the **parent directory** of this repo.
Usual `<path-to-repo>`:
- **linux**: `~/.config/nvim`
- **windows**: `$env:USERPROFILE\appdata\local\nvim`
Youll need to **symlink or hard link** them into the appropriate locations:
### 📁 `lsd` Pretty Directory Listings ### 📁 `lsd` Pretty Directory Listings
- **Target**: `~/.config/lsd/config.yaml` #### 💲zsh,bash
- **Source**: `<repo-root>/lsd-config.yaml`
- **Link Type**: **Symlink**
```zsh ```zsh
mkdir -p ~/.config/lsd mkdir -p ~/.config/lsd
ln -s <path-to-repo>/lsd-config.yaml ~/.config/lsd/config.yaml ln -s <path-to-repo>/config_files/lsd_config.yaml ~/.config/lsd/config.yaml
ln -s <path-to-repo>/config_files/lsd_icons.yaml ~/.config/lsd/icons.yaml
```
####  powershell
```ps1
Remove-Item "$env:USERPROFILE\.config\lsd\icons.yaml" -ErrorAction Ignore;
Remove-Item "$env:USERPROFILE\.config\lsd\config.yaml" -ErrorAction Ignore;
New-Item -ItemType SymbolicLink -Target "$env:USERPROFILE\<path-to-repo>config_files\lsd_icons.yaml"
-Path "$env:USERPROFILE\.config\lsd\icons.yaml"
New-Item -ItemType SymbolicLink -Target "<path-to-repo>\config_files\lsd_config.yaml"
-Path "$env:USERPROFILE\.config\lsd\config.yaml"
```
###  `Wezterm` Terminal Emulator of Choice
####  powershell
```ps1
[System.Environment]::SetEnvironmentVariable("WEZTERM_CONFIG_FILE", "<path-to-repo>/config_files/wezterm.lua", "User")
```
#### 💲zsh,bash
```zsh
Included in .zshrc
```
###  ZSH
```zsh
ln -s <path-to-repo>/zsh/.zshrc ~/.zshrc

View File

@@ -1,38 +1,38 @@
{ {
"LazyVim": { "branch": "main", "commit": "3f034d0a7f58031123300309f2efd3bb0356ee21" }, "LazyVim": { "branch": "main", "commit": "25abbf546d564dc484cf903804661ba12de45507" },
"SchemaStore.nvim": { "branch": "main", "commit": "442901b78dca4da1078b32e25e1afb32460e0082" }, "SchemaStore.nvim": { "branch": "main", "commit": "9ecd375f7c261f622bd811ecebcddd59bf5e9de2" },
"blink.cmp": { "branch": "main", "commit": "cb5e346d9e0efa7a3eee7fd4da0b690c48d2a98e" }, "blink.cmp": { "branch": "main", "commit": "bae4bae0eedd1fa55f34b685862e94a222d5c6f8" },
"bufferline.nvim": { "branch": "main", "commit": "655133c3b4c3e5e05ec549b9f8cc2894ac6f51b3" }, "bufferline.nvim": { "branch": "main", "commit": "655133c3b4c3e5e05ec549b9f8cc2894ac6f51b3" },
"catppuccin": { "branch": "main", "commit": "5b5e3aef9ad7af84f463d17b5479f06b87d5c429" }, "catppuccin": { "branch": "main", "commit": "76a8d0515024cc55d8bd26fc13f1af88faef3ebf" },
"conform.nvim": { "branch": "master", "commit": "372fc521f8421b7830ea6db4d6ea3bae1c77548c" }, "conform.nvim": { "branch": "master", "commit": "973f3cb73887d510321653044791d7937c7ec0fa" },
"flash.nvim": { "branch": "main", "commit": "3c942666f115e2811e959eabbdd361a025db8b63" }, "flash.nvim": { "branch": "main", "commit": "3c942666f115e2811e959eabbdd361a025db8b63" },
"friendly-snippets": { "branch": "main", "commit": "fc8f183479a472df60aa86f00e295462f2308178" }, "friendly-snippets": { "branch": "main", "commit": "572f5660cf05f8cd8834e096d7b4c921ba18e175" },
"gitsigns.nvim": { "branch": "main", "commit": "140ac646db125904e456e42ab8b538d28f9607d7" }, "gitsigns.nvim": { "branch": "main", "commit": "c7d37ca22b461f64e26f8f6701b2586128ed0bef" },
"grug-far.nvim": { "branch": "main", "commit": "631331f9c6611b1a47e887f50b92b7cf450f51e7" }, "grug-far.nvim": { "branch": "main", "commit": "385d1949dc21d0c39e7a74b4f4a25da18817bc86" },
"lazy.nvim": { "branch": "main", "commit": "6c3bda4aca61a13a9c63f1c1d1b16b9d3be90d7a" }, "lazy.nvim": { "branch": "main", "commit": "6c3bda4aca61a13a9c63f1c1d1b16b9d3be90d7a" },
"lazydev.nvim": { "branch": "main", "commit": "2367a6c0a01eb9edb0464731cc0fb61ed9ab9d2c" }, "lazydev.nvim": { "branch": "main", "commit": "2367a6c0a01eb9edb0464731cc0fb61ed9ab9d2c" },
"lualine.nvim": { "branch": "master", "commit": "15884cee63a8c205334ab13ab1c891cd4d27101a" }, "lualine.nvim": { "branch": "master", "commit": "a94fc68960665e54408fe37dcf573193c4ce82c9" },
"markdown-preview.nvim": { "branch": "master", "commit": "a923f5fc5ba36a3b17e289dc35dc17f66d0548ee" }, "markdown-preview.nvim": { "branch": "master", "commit": "a923f5fc5ba36a3b17e289dc35dc17f66d0548ee" },
"mason-lspconfig.nvim": { "branch": "main", "commit": "1a31f824b9cd5bc6f342fc29e9a53b60d74af245" }, "mason-lspconfig.nvim": { "branch": "main", "commit": "1a31f824b9cd5bc6f342fc29e9a53b60d74af245" },
"mason.nvim": { "branch": "main", "commit": "fc98833b6da5de5a9c5b1446ac541577059555be" }, "mason.nvim": { "branch": "main", "commit": "fc98833b6da5de5a9c5b1446ac541577059555be" },
"mini.ai": { "branch": "main", "commit": "e139eb1101beb0250fea322f8c07a42f0f175688" }, "mini.ai": { "branch": "main", "commit": "1cd4f021a05c29acd4ab511c0981da14217daf38" },
"mini.icons": { "branch": "main", "commit": "397ed3807e96b59709ef3292f0a3e253d5c1dc0a" }, "mini.icons": { "branch": "main", "commit": "b8f6fa6f5a3fd0c56936252edcd691184e5aac0c" },
"mini.pairs": { "branch": "main", "commit": "69864a2efb36c030877421634487fd90db1e4298" }, "mini.pairs": { "branch": "main", "commit": "1e1ca3f60f58d4050bf814902b472eec9963a5dd" },
"noice.nvim": { "branch": "main", "commit": "0427460c2d7f673ad60eb02b35f5e9926cf67c59" }, "noice.nvim": { "branch": "main", "commit": "0427460c2d7f673ad60eb02b35f5e9926cf67c59" },
"nui.nvim": { "branch": "main", "commit": "8d5b0b568517935d3c84f257f272ef004d9f5a59" }, "nui.nvim": { "branch": "main", "commit": "de740991c12411b663994b2860f1a4fd0937c130" },
"nvim-lint": { "branch": "master", "commit": "9dfb77ef6c5092a19502883c02dc5a02ec648729" }, "nvim-lint": { "branch": "master", "commit": "7ef127aaede2a4d5ad8df8321e2eb4e567f29594" },
"nvim-lspconfig": { "branch": "master", "commit": "7d32353d99fa24c9c2fac993b8378afbc92df94b" }, "nvim-lspconfig": { "branch": "master", "commit": "276ce3bc878243dc63c32b75790c4296d11848f6" },
"nvim-treesitter": { "branch": "master", "commit": "684eeac91ed8e297685a97ef70031d19ac1de25a" }, "nvim-treesitter": { "branch": "master", "commit": "42fc28ba918343ebfd5565147a42a26580579482" },
"nvim-treesitter-textobjects": { "branch": "master", "commit": "205e3369bc83d8cb83f7409c36120e24611f8c5c" }, "nvim-treesitter-textobjects": { "branch": "master", "commit": "71385f191ec06ffc60e80e6b0c9a9d5daed4824c" },
"nvim-ts-autotag": { "branch": "main", "commit": "a1d526af391f6aebb25a8795cbc05351ed3620b5" }, "nvim-ts-autotag": { "branch": "main", "commit": "a1d526af391f6aebb25a8795cbc05351ed3620b5" },
"persistence.nvim": { "branch": "main", "commit": "166a79a55bfa7a4db3e26fc031b4d92af71d0b51" }, "persistence.nvim": { "branch": "main", "commit": "166a79a55bfa7a4db3e26fc031b4d92af71d0b51" },
"plenary.nvim": { "branch": "master", "commit": "857c5ac632080dba10aae49dba902ce3abf91b35" }, "plenary.nvim": { "branch": "master", "commit": "b9fd5226c2f76c951fc8ed5923d85e4de065e509" },
"render-markdown.nvim": { "branch": "main", "commit": "6910fe12a9634be5ce4e19aff4d3b45abf3f0dd3" }, "render-markdown.nvim": { "branch": "main", "commit": "3da7bb459f6cff03980dd1e106c46f3e62ff4d9f" },
"snacks.nvim": { "branch": "main", "commit": "bc0630e43be5699bb94dadc302c0d21615421d93" }, "snacks.nvim": { "branch": "main", "commit": "bc0630e43be5699bb94dadc302c0d21615421d93" },
"todo-comments.nvim": { "branch": "main", "commit": "304a8d204ee787d2544d8bc23cd38d2f929e7cc5" }, "todo-comments.nvim": { "branch": "main", "commit": "304a8d204ee787d2544d8bc23cd38d2f929e7cc5" },
"tokyonight.nvim": { "branch": "main", "commit": "057ef5d260c1931f1dffd0f052c685dcd14100a3" }, "tokyonight.nvim": { "branch": "main", "commit": "057ef5d260c1931f1dffd0f052c685dcd14100a3" },
"trouble.nvim": { "branch": "main", "commit": "85bedb7eb7fa331a2ccbecb9202d8abba64d37b3" }, "trouble.nvim": { "branch": "main", "commit": "85bedb7eb7fa331a2ccbecb9202d8abba64d37b3" },
"ts-comments.nvim": { "branch": "main", "commit": "1bd9d0ba1d8b336c3db50692ffd0955fe1bb9f0c" }, "ts-comments.nvim": { "branch": "main", "commit": "1bd9d0ba1d8b336c3db50692ffd0955fe1bb9f0c" },
"venv-selector.nvim": { "branch": "regexp", "commit": "c677caa1030808a9f90092e522de7cc20c1390dd" }, "venv-selector.nvim": { "branch": "regexp", "commit": "c2d888f416c3572c27ab9ef936443ce7cd98762b" },
"which-key.nvim": { "branch": "main", "commit": "370ec46f710e058c9c1646273e6b225acf47cbed" } "which-key.nvim": { "branch": "main", "commit": "370ec46f710e058c9c1646273e6b225acf47cbed" }
} }

View File

@@ -103,5 +103,7 @@ eval "$(~/.local/repos/rbenv/bin/rbenv init - --no-rehash zsh)"
export GOPATH=$HOME/workspace/go-tools export GOPATH=$HOME/workspace/go-tools
export GOBIN=$GOPATH/bin export GOBIN=$GOPATH/bin
export PATH="$GOBIN:/usr/local/go/bin:$PATH" export PATH="$GOBIN:/usr/local/go/bin:$PATH"
# wezterm
export WEZTERM_CONFIG_FILE=$HOME/.config/nvim/config_files/wezterm.lua
# Message of the day # Message of the day
~/.config/nvim/zsh/motd.sh ~/.config/nvim/zsh/motd.sh