Rewrite README

README.md

@@ -1,61 +1,47 @@
-# `requirements.txt`
+# Getting started
-* cli-ui        -> build user interface in the terminal
+The Python requirements are all in `requirements.txt`, so before starting you need to issue the following command:
-* colorama      -> dependency of cli-ui
+```sh
-* unidecode     -> dependency of cli-ui
+$ pip install -r requirements.txt --user
-* ruamel.yaml   -> load and dump yaml with python
+```
-* path          -> create path objects (alternative to os.path)
+**without** using sudo. Using sudo with pip is a bad idea because it will interfere with your distribution's package manager.
 
-# `bootstrap.sh`
+# About the files in the repo
-* installs pip
+* `arch-desktop_borg.sh`
-* uses pip to install from requirements.txt
-* installs rustup
-* uses cargo to install fd-find and exa
-* copies xkb-symbols: https://medium.com/@damko/a-simple-humble-but-comprehensive-guide-to-xkb-for-linux-6f1ad5e13450
 
-# `configs.yml`
+    Borg backup script. Used by a pacman hook to backup my system.
-* holds the symlinks, git clones and config writes
 
-# `install.py`
+* `configs.yml`
 
-## main()
+    Lists the things to install, which includes programs, symlinks, git clones, shell commands...
-* parses args: undefined number of programs as a list
-* has a flag to overwrite (--force)
-* Installer is a class, --force flag is passed to constructor
-* runs Installer.install with the programs list
 
-## class Installer(force=False)
+* `dotfiles/`
-* self.conf -> load `configs.yml`
+
-* self.this_dir = getcwd()
+    The actual dotfiles. They are symlinked to the location that the system expects to find them.
-* self.home = ~ (expanduser)
+
-* self.force = force
+* `git_hooks/`
-* install():
+
-    - if no program in list, programs are found in self.conf
+    See `symlink_git_hooks.sh`.
-    - for each program, run install_program(program)
+
-* install_program(program)
+* `install.py`
-    - print program name
+
-    - look up program conf and assign to `todo` variable
+    Installs everything using `configs.yml`. This is the file to actually run.
-    - for each action in `todo`, call corresponding method
+
-* do_clone(url, dest, branch='master'):
+* `firefox_addons.txt`
-    - create dirs for dest recursively
+
-    - use subprocess to issue git clone command
+    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.
-* do_copy(src, dest):
+
-    - create dirs for dest recursively
+* `pacman_hooks/`
-    - copy a config file to dest
+
-* do_download(*, url, dest, executable=False):
+    You need to manually copy or symlink any hook to `/etc/pacman.d/hooks/` to activate it.
-    - create dirs for dest recursively
+
-    - fetch url to dest
+* `shellcheck_binary_fix.sh`
-    - if it should be executable, chmod it to 755
+
-* do_run(args):
+    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.
-    - args is a list
+
-    - from that list, create a command
+* `symlink_git_hooks.sh`
-    - subprocess.check_call(command)
+
-* do_symlink(src, dest):
+    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.
-    - if is_dir make tree from parent.parent
+
-    - if not is_dir make tree from parent
+* `todo`
-    - if dest is a link, remove it
+
-    - create the symlink
+    Never seems to remain empty...
-* do_write(src, contents):
-    - create path to src
-    - format the content with self.this_dir and self.home
-    - add newline at end
-    - write to file