xonecas.io
56101
Df

dotfiles / commit 544e9cd

docs: update READMEs to reflect repository structure

- Add missing shell configuration section to main README
- Document LSP support and Mason installer in Neovim README
- Enhance installation instructions with selective install options
- Add requirements and post-installation steps
- Fix inconsistencies between documentation and actual codebase

xonecas2026-01-29 544e9cd774d671837317e700439daedfa19d6a2c parent 69d05bc

2 files changed

README.md+71−9
@@ -12,26 +12,74 @@ This repository contains my personal configuration files (dotfiles) for various
1212
1313 Location: `nvim/`
1414
15-My Neovim setup with custom keybindings, plugins, and color schemes.
15+Modern Neovim setup using Lua and lazy.nvim plugin manager with LSP support, git integration, and a buffer-based file explorer.
1616
17-- **init.lua** - Main configuration file
18-- **lua/plugins/** - Plugin configurations using lazy.nvim
19-- **colors/** - Custom color schemes
17+- **init.lua** - Main configuration file with basic settings and keybindings
18+- **lua/plugins/** - Plugin configurations (oil, LSP with Mason, gitsigns, diffview, lualine, comment)
19+- **colors/ansi.vim** - Terminal-respecting 16-color ANSI colorscheme
2020 - **README.md** - Detailed Neovim setup documentation
2121
22+**Key Features:**
23+- Leader key: Space
24+- Buffer-centric workflow with oil.nvim
25+- LSP support with Mason installer
26+- Git integration (gitsigns + diffview)
27+- Minimal, focused configuration
28+
2229 ### OpenCode Configuration
2330
2431 Location: `opencode/`
2532
26-Configuration for the OpenCode AI coding assistant.
33+Configuration for the OpenCode AI coding assistant with custom behaviors, commands, and reusable skills.
34+
35+- **AGENTS.md** - Core agent behavior and debugging principles
36+- **commands/** - Custom slash commands (commit-all, format-then-lint)
37+- **skills/** - Reusable skills (good-programming-principles, token-efficiency-opencode)
38+
39+**Key Principles:**
40+- Never lie, deceive, or omit information
41+- Always find root cause before fixing issues
42+- Apply KISS, DRY, YAGNI, SOLID principles
43+- Minimize token usage
44+
45+### Shell Configuration
46+
47+Location: `shell/`
48+
49+Shared shell configuration for bash and zsh with aliases and functions.
2750
28-- **AGENTS.md** - Agent behavior and instructions
29-- **commands/** - Custom slash commands
30-- **skills/** - Reusable skills for specific tasks
51+- **shared.sh** - Common shell aliases, environment variables, and functions
52+- **install.sh** - Installation script that symlinks config and sources it in shell rc files
53+
54+**Features:**
55+- Git aliases (g, gst, gc, gp, gpo)
56+- File listing aliases (ll, ls with color)
57+- Editor setup (EDITOR=nvim)
58+- Fun greeting function using fortune, cowsay, and lolcat
3159
3260 ## Installation
3361
34-Use the provided `install.sh` or symlink the desired config directories or files to their expected locations:
62+The repository includes a master installation script that can install all configs or specific ones.
63+
64+### Install Everything
65+
66+```bash
67+cd /path/to/dotfiles
68+./install.sh
69+```
70+
71+### Install Specific Configs
72+
73+```bash
74+./install.sh nvim # Only Neovim
75+./install.sh opencode # Only OpenCode
76+./install.sh shell # Only Shell config
77+./install.sh nvim shell # Multiple specific configs
78+```
79+
80+### Manual Symlinks
81+
82+Alternatively, symlink the desired config directories to their expected locations:
3583
3684 ```bash
3785 # Neovim
@@ -39,9 +87,23 @@ ln -s /path/to/dotfiles/nvim ~/.config/nvim
3987
4088 # OpenCode
4189 ln -s /path/to/dotfiles/opencode ~/.config/opencode
90+
91+# Shell (or use shell/install.sh for automatic shell rc integration)
92+ln -s /path/to/dotfiles/shell ~/.config/shell
4293 ```
4394
4495 ## Requirements
4596
97+### Core Requirements
4698 - Neovim >= 0.9.0
99+- Git
47100 - OpenCode CLI tool
101+
102+### Optional Dependencies
103+- fortune, cowsay, lolcat (for shell greeting function)
104+
105+## Post-Installation
106+
107+1. **Neovim**: Open nvim - plugins will auto-install via lazy.nvim on first run
108+2. **Shell**: Restart your shell to load new aliases and functions
109+3. **LSP Servers**: Install LSP servers via `:Mason` in Neovim if needed
nvim/README.md+17−3
@@ -10,6 +10,7 @@ Modern Neovim configuration using Lua and lazy.nvim plugin manager.
1010 ├── lua/
1111 │ └── plugins/ # Plugin configurations
1212 │ ├── oil.lua # File explorer
13+│ ├── lsp.lua # LSP configuration with Mason
1314 │ ├── diffview.lua # Git diff viewer
1415 │ ├── gitsigns.lua # Git decorations
1516 │ ├── comment.lua # Comment toggling
@@ -24,6 +25,11 @@ Modern Neovim configuration using Lua and lazy.nvim plugin manager.
2425 ### File Management
2526 - **oil.nvim** - Edit your filesystem like a buffer. Press `-` or `<Space>n` to open.
2627
28+### Language Server Protocol (LSP)
29+- **nvim-lspconfig** - LSP client configuration for Neovim
30+- **mason.nvim** - Package manager for LSP servers, DAP servers, linters, and formatters
31+- **mason-lspconfig.nvim** - Bridge between mason.nvim and nvim-lspconfig
32+
2733 ### Git Integration
2834 - **diffview.nvim** - Review git changes, commits, and file history with ease.
2935 - **gitsigns.nvim** - Inline git decorations showing added/changed/deleted lines in the sign column.
@@ -48,18 +54,23 @@ Modern Neovim configuration using Lua and lazy.nvim plugin manager.
4854 :Lazy
4955 ```
5056
51-4. Try the file explorer:
57+4. Install LSP servers (optional):
58+ ```
59+ :Mason
60+ ```
61+
62+5. Try the file explorer:
5263 ```
5364 Press <Space>n or -
5465 ```
5566
56-5. Try commenting:
67+6. Try commenting:
5768 ```
5869 Press gcc (toggle comment on line)
5970 Press gc + motion (comment with motion, e.g., gcap)
6071 ```
6172
62-6. Try git integration (in a git repo):
73+7. Try git integration (in a git repo):
6374 ```
6475 Press <Space>dv (open diffview)
6576 Press ]c (next git change)
@@ -68,6 +79,7 @@ Modern Neovim configuration using Lua and lazy.nvim plugin manager.
6879 ## Key Features
6980
7081 - **Leader key**: `Space`
82+- **LSP support**: Language server protocol with Mason package manager for easy server installation
7183 - **File explorer**: Buffer-based with oil.nvim (edit filesystem like text)
7284 - **Git diff viewer**: Comprehensive diff interface with diffview.nvim
7385 - **Git decorations**: Inline change markers with gitsigns.nvim
@@ -91,6 +103,8 @@ Modern Neovim configuration using Lua and lazy.nvim plugin manager.
91103 ## Resources
92104
93105 - [lazy.nvim docs](https://github.com/folke/lazy.nvim)
106+- [nvim-lspconfig docs](https://github.com/neovim/nvim-lspconfig)
107+- [mason.nvim docs](https://github.com/williamboman/mason.nvim)
94108 - [oil.nvim docs](https://github.com/stevearc/oil.nvim)
95109 - [diffview.nvim docs](https://github.com/sindrets/diffview.nvim)
96110 - [gitsigns.nvim docs](https://github.com/lewis6991/gitsigns.nvim)