X-Git-Url: https://git.xinqibao.xyz/dotfiles.git/blobdiff_plain/66b16d6883d77d4e524536af5c342a838c5e0db9..c487919b66f0f3863569ee5903e019e96fa27d64:/README.md?ds=inline

diff --git a/README.md b/README.md
index 4734362..4d3ef82 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,25 @@
 # dotfiles
 
-Personal configuration for shell, editor, terminal, and development tools. Files follow their usual locations under the home directory, including `.bashrc`, `.tmux.conf`, `.vimrc`, and `.config/`.
+Personal configuration for Bash, tmux, Vim, Neovim, C/C++ tooling, and X11. Configuration paths mirror their intended locations relative to `$HOME`. This repository has no installer.
 
-Review the relevant files before applying them to another machine. Copy or merge the settings you need into the tool's configuration, then check that the tool behaves as expected. Some settings depend on installed plugins, commands, or platform-specific features.
+## Contents
+
+- `.bashrc`, `.tmux.conf`: shell and terminal multiplexer settings.
+- `.config/mise/config.toml`: optional versions for selected interactive tools.
+- `.vimrc`, `.config/nvim/`: separate Vim and Neovim configurations.
+- `.clang-format`, `.config/clangd/`, `.ycm_extra_conf.py`: C/C++ tooling.
+- `.xinitrc`, `.config/x11/`: X11 startup, resources, and key bindings.
+
+## Use
+
+Link or copy the relevant files into place, or merge them with existing settings. Editor plugins and external commands generally require separate installation. Review hard-coded paths, display settings, and other machine-specific assumptions before use, then test the affected tools.
+
+Optional: [install mise](https://mise.jdx.dev/getting-started.html), link or copy its configuration to `$HOME/.config/mise/config.toml`, then run `mise install` from `$HOME`. Bash activates mise when available; installed tools take precedence on `PATH`. Use `mise upgrade` to update them. mise manages selected interactive tools; system packages and project toolchains remain separate.
+
+Neovim installs its parser baseline asynchronously; reopen the buffer after installation. Use `:TSInstall <language>` for additional parsers and `:TSUpdate` after plugin updates. Installation requires tree-sitter CLI, a C compiler, curl, and tar.
+
+## Maintenance
+
+Prefer each tool's supported commands, APIs, and defaults where they fit the intended workflow. Treat upstream examples as patterns to evaluate against this configuration and environment, not recipes to copy unchanged. Add small local code only for a concrete need.
+
+Before changing behavior, inspect the related and sourced files, mappings, and dependencies. Keep edits focused, verify startup and affected workflows, and describe intentional behavior changes or validation limits.