aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLuca Matei Pintilie <lucafulger@gmail.com>2023-02-04 20:58:34 +0000
committerLuca Matei Pintilie <lucafulger@gmail.com>2023-02-04 20:58:34 +0000
commit3f14402e27e52c46f2ae546e8386a23aa53890ee (patch)
tree30493b9301cfdc313068cd5d77e7ebdd0ef18139 /README.md
parent38c88a1ced242fdac3bb2a6b42214875f798871d (diff)
downloaddotfiles-3f14402e27e52c46f2ae546e8386a23aa53890ee.tar
dotfiles-3f14402e27e52c46f2ae546e8386a23aa53890ee.tar.gz
dotfiles-3f14402e27e52c46f2ae546e8386a23aa53890ee.tar.bz2
dotfiles-3f14402e27e52c46f2ae546e8386a23aa53890ee.tar.lz
dotfiles-3f14402e27e52c46f2ae546e8386a23aa53890ee.tar.xz
dotfiles-3f14402e27e52c46f2ae546e8386a23aa53890ee.tar.zst
dotfiles-3f14402e27e52c46f2ae546e8386a23aa53890ee.zip
Fill out the README a bit more
Diffstat (limited to '')
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
index e8124da..4b89451 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,40 @@
+# AnInternetTroll's dotfiles
+
+To install these dotfiles run the following command
+
+```sh
+./bootstrap.sh
+```
+
+This will install **and replace** all appropriate files in your home folder.
+
# Dependencies
+Here is an incomplete list of the required dependencies for each configuration.
+
+## Sway
+
+- Terminal (either one works)
+ - [foot](https://codeberg.org/dnkl/foot)
+ - [alacritty](https://alacritty.org/)
+- Screenshot
+ - slurp
+ - grim
+ - swappy
+- [wofi](https://hg.sr.ht/~scoopta/wofi)
+- swaylock
+- swaybg
+- swayidle
+- brightnessctl
+- pactl
+- playerctl
+- waybar
+- dunst
+
## Neovim
- [vscode-langservers-extracted](https://www.npmjs.com/package/vscode-langservers-extracted)
- `npm i -g vscode-langservers-extracted`
+- [deno](https://deno.land)
+- [git](https://git-scm.com/)