summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorZachIR <zachir@zdx-raina>2023-07-10 22:39:55 -0500
committerzachir <zachir@librem.one>2023-07-18 00:17:40 -0500
commit8a7745a5a659170e9352e529e22f38f92ca22eef (patch)
tree070e7327d6dd5e1873eb07bf3a86c336fa02f155 /README.md
parent0547bc65b54aef2b3a57fda75603f085337d7505 (diff)
Update README to be accurate for, quite possibly, the second time ever.
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index 9acdf05..2644588 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,22 @@
## Zachir's Config Files
-Hello! These are all the config files I thought could potentially be useful, both to myself to make reinstalling Linux faster, as well as for anyone interested. There are a few notes I feel I should make:
+Hello! These are all the config files I thought could potentially be useful,
+both to myself to make reinstalling Linux faster, as well as for anyone
+interested. There are a few notes I feel I should make:
-- I have a custom dwm build, which sources 'autostart.sh' and 'autostart_blocking.sh' from __*.config/dwm*__ not *.dwm*. This is available [here](https://gitlab.com/zachir/dwm-zir).
-- I also have a custom st build, which sources '.Xresources' (this is a common enough patch, but I thought I would mention it, as I include my .Xresources file) available [here](https://gitlab.com/zachir/st-zir).
-- I have gone through everything to remove personal information, however I might have missed something. If that happens, this repo will be updated, and the branch history deleted.
+- I have gone through everything to remove personal information, however I might
+ have missed something. If that happens, this repo will be updated, and the
+ branch history deleted.
-My personal installation method is as follows (performed immediately following a clean install):
-`git clone https://gitlab.com/zachir/dotfiles ~/.config
+My personal installation method is as follows (performed immediately following a
+clean install):
+`git clone https://git.zachir.xyz/dotfiles.git ~/.config
cd ~/.config
make install`
-Note that the `make install` will only install the files in `HOME` to their corresponding place in the home dir as hard links. Make sure to save changes to these files before cloning! Additionally, if you only want my configs for specific programs, I would recommend cloning it into a separate directory and avoiding the `make install`.
+Note that the `make install` will only install the files that are required to be
+in the home dir to their corresponding place as hard links and install vimplug
+for neovim, vim, or both (depending on which are installed). Make sure to save
+changes to these files before running `make install`! Additionally, if you only
+want my configs for specific programs, I would recommend cloning it into a
+separate directory and avoiding the `make install`.