From: Xinqi Bao <xbao@xinqibao.xyz>
Date: Sat, 26 Sep 2026 14:33:59 +0000 (+0800)
Subject: docs: describe dotfiles usage
X-Git-Url: https://git.xinqibao.xyz/dotfiles.git/commitdiff_plain/66b16d6883d77d4e524536af5c342a838c5e0db9?ds=sidebyside

docs: describe dotfiles usage
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4734362
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# 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/`.
+
+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.