diff --git a/README.md b/README.md index e02f052..4e877af 100644 --- a/README.md +++ b/README.md @@ -5,43 +5,48 @@ $ pip install -r requirements.txt --user ``` **without** using sudo. Using sudo with pip is a bad idea because it will interfere with your distribution's package manager. +If on a fresh install, you won't have `pip` installed, so you'll need: +```sh +$ sudo pacman -S python-pip +``` +or +```sh +$ sudo apt install python3-pip +``` + +Then run `./install.py` + # About the files in the repo -* `arch-desktop_borg.sh` +* `arch-desktop_borg.sh`
+Borg backup script. Used by a pacman hook to backup my system. - Borg backup script. Used by a pacman hook to backup my system. +* `configs.yml`
+Lists the things to install, which includes programs, symlinks, git clones, shell commands... -* `configs.yml` +* `dotfiles/`
+The actual dotfiles. They are symlinked to the location that the system expects to find them. - Lists the things to install, which includes programs, symlinks, git clones, shell commands... +* `git_hooks/`
+See `symlink_git_hooks.sh`. -* `dotfiles/` +* `install.py`
+Installs everything using `configs.yml`. This is the file to actually run. - The actual dotfiles. They are symlinked to the location that the system expects to find them. +* `firefox_addons.txt`
+I like to install my Firefox add-ons manually in the Firefox add-on manager, so this file just reminds me what to install and includes the urls to each add-on. -* `git_hooks/` +* `pacman_hooks/`
+You need to manually copy or symlink any hook to `/etc/pacman.d/hooks/` to activate it. - See `symlink_git_hooks.sh`. +* `shellcheck_binary_fix.sh`
+When running this on Manjaro, pacman was unable to find the shellcheck package, so this script installs the pre-compiled binary instead. If your package manager finds shellcheck, this script won't run. -* `install.py` +* `symlink_git_hooks.sh`
+Helper script to symlink any hook in `git_hooks/` to your local `.git/hooks/` folder. Only for personal use to keep my git hooks version controlled. - Installs everything using `configs.yml`. This is the file to actually run. +* `todo`
+Never seems to remain empty... -* `firefox_addons.txt` - I like to install my Firefox add-ons manually in the Firefox add-on manager, so this file just reminds me what to install and includes the urls to each add-on. - -* `pacman_hooks/` - - You need to manually copy or symlink any hook to `/etc/pacman.d/hooks/` to activate it. - -* `shellcheck_binary_fix.sh` - - When running this on Manjaro, pacman was unable to find the shellcheck package, so this script installs the pre-compiled binary instead. If your package manager finds shellcheck, this script won't run. - -* `symlink_git_hooks.sh` - - Helper script to symlink any hook in `git_hooks/` to your local `.git/hooks/` folder. Only for personal use to keep my git hooks version controlled. - -* `todo` - - Never seems to remain empty... +# Thanks +The idea for the architecture was taken from Dimitri Merejkowsky's [GitHub](https://github.com/dmerejkowsky/dotfiles).