aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 14 insertions, 19 deletions
diff --git a/README.md b/README.md
index 0c8d64f..f6b672b 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,14 @@
-Install dotfiles with the deploy script:
-
- $ sh deploy.sh
-
-Tries to follow the [XDG base directory
-spec](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
-as much as possible.
-
-The script does the following:
-
- * Clear out `$PWD/dotfiles-backup/`.
- * Symlink everything under `config` into `$XDG_CONFIG_HOME`. Moves everything
- that already exists to `$PWD/dotfiles-backup/` first.
- * Symlink everything under `home` into `$HOME`. Again back up existing files to
- `$PWD/dotfiles-backup`.
- * Clone Vundle into `~/.vim/bundle/vundle/` and run `BundleInstall`.
- * Copy files under `local` into the appropriate locations only if they don't
- already exist. These are for handling local configuration that shouldn't or
- can't be version controlled.
+Manages dotfiles with stow and make.
+
+Make targets:
+ * `console`: configs for os-independent cli tools
+ * `fedora-packages`: install rpmfusion and fedora packages (standalone, should
+ only need to be run once unless new packages or repos are added)
+ * `fedora`: configs for fedora-specific gui tools (depends on `console`)
+ * `restore`: restore committed versions of files in `stow\` and `sway-de/`
+
+Note: stow is run with the `--adopt` option, which will overwrite files in the
+stow directory with the version that would be replaced with a symlink. You can
+do a `git diff` to see the differences and if you don't care about them you can
+quickly revert to the committed versions with `make restore`. Makefile will do
+it's best to abort if there are uncommitted changes in the repo.