aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPolesznyák Márk <contact@pml68.dev>2025-11-29 00:21:56 +0100
committerPolesznyák Márk <contact@pml68.dev>2025-11-29 00:36:55 +0100
commit3d340c689b39427f1b29b642baa108d7f5fc39ac (patch)
treed60483635a42e28278bb81c8c199cb5dad03c823 /README.md
downloaddotfiles-3d340c689b39427f1b29b642baa108d7f5fc39ac.tar.gz
feat: initial commit
Diffstat (limited to '')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ef4e06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# dotfiles
+
+This is my main dotfiles repo, though not all components are here. Namely:
+- [`nvim-setup`](https://github.com/pml68/nvim-setup): my Neovim configuration
+- [`suckless-setup`](https://git.sr.ht/~pml68/suckless-setup): my suckless desktop setup (dwm, dmenu, slstatus, st & fetcha)
+
+## Usage
+
+GNU Stow and Git are required. To install, simply run `make install`. To remove the created symlinks, run `make uninstall`.
+
+### tmux
+
+`make install` will download tmux plugin manager, but to install all plugins in the configuration you must start `tmux` and press `C-a I`.