about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
authorVitor Gonçalves <vitorg@tilde.team>2023-12-04 03:16:26 -0300
committerVitor Gonçalves <vitorg@tilde.team>2023-12-04 03:16:26 -0300
commit4e72db0c587aa732c853453cd06c727c6ac8fe56 (patch)
tree3edf17abde42dd1e55c196889276f11a0972a6a1 /README.md
parent959f43ea74e1c9a92a07697c5cd8e5cd1d4d1bac (diff)
downloaddots-4e72db0c587aa732c853453cd06c727c6ac8fe56.tar.gz
updated README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 25 insertions, 4 deletions
diff --git a/README.md b/README.md
index b15794b..56ed795 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,29 @@
 # dotfiles
 
-Hello, and welcome! This is the place that i store my dotfiles. Here you can find:
+hello, and welcome! this is the place that i store my dotfiles.
 
-* A customization of Sway (using i3status for now, may switch to waybar)
-* Small config for foot
+i have
+* a customization of sway (using i3status for now, may switch to waybar)
+* small config for foot
 
-It's still WIP! If you have any suggestions, feel free to email me [here](mailto:vitorg@tilde.team), or to contact me via Matrix [here](https://mto.vern.cc/#/@vitorg:vern.cc).
+it's still wip! if you have any suggestions, feel free to email me [here](mailto:vitorg@tilde.team), or to contact me via matrix [here](https://mto.vern.cc/#/@vitorg:vern.cc).
+
+## cloning this repo
+
+i manage my dotfiles using a bare git repository. here's a quick rundown on how to get this dotfiles for yourself:
+
+```sh
+alias cfg='git --git-dir=$HOME/.local/share/dotfiles-repo/ --work-tree=$HOME'
+git clone --bare https://git.vern.cc/vitorg/dots $HOME/.local/share/dotfiles-repo
+cfg checkout
+```
+
+if you find an issue while performing the last command, you'll probably have a list of files you already have in your ~. if that's the case, then move/delete them and try again
+
+and finally:
+
+```sh
+cfg config --local status.showUntrackedFiles no
+```
+
+_this is mostly for my personal use tho lol_