aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..31c7eb8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# dotfiles
+
+Configs for editorconfig, tmux, and NeoVim. Managed with GNU Stow.
+
+## Install on a new machine
+
+```sh
+git clone <this-repo> ~/src/dotfiles
+cd ~/src/dotfiles
+stow editorconfig tmux nvim
+```
+
+Stow reads the target (`$HOME`) from `.stowrc`.
+
+NeoVim installs its own plugins and language servers on first start.
+
+## Notes
+
+- The tmux status color `#272c2e` matches a terminal background of
+ `#2E3436`. Adjust it on machines with a different terminal theme.