aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorToby Vincent <tobyv13@gmail.com>2022-03-26 22:09:34 -0500
committerToby Vincent <tobyv13@gmail.com>2022-03-26 22:09:34 -0500
commit2420f0bfd9bfef583156b288b0c7a8c7abd47141 (patch)
treec994e2b25a584a58dfd44e511087e6297e78a836
parentddd1244820f8108efc483532a17f168c6560a8a5 (diff)
docs: rewrite README
-rw-r--r--README.md67
1 files changed, 5 insertions, 62 deletions
diff --git a/README.md b/README.md
index 2844c39..21b2801 100644
--- a/README.md
+++ b/README.md
@@ -1,73 +1,16 @@
tobyvin's dotfiles
==================
-
Install
-------
-Clone the repo and its submodules, then install links.
-
```sh
-git clone https://github.com/tobyvin/dotfiles.git ~/dotfiles && ~/dotfiles/install
-```
-
-The install **will override** the following configs by default:
-- ~/.zshrc
-- ~/.p10k.zsh
-- ~/.gitconfig
-- ~/.ssh/config
-- ~/.gnupg/gpg.conf
-
-
-To disable overwriting existing configs, set `defaults.link.force` in [install.conf.yaml](install.conf.yaml) to `false`:
-
-```yaml
-# file: install.conf.yaml
-- defaults:
- link:
- create: true
- relink: true
- force: false <--
+git clone https://github.com/tobyvin/.dotfiles.git ~/.dotfiles && cd ~/.dotfiles && make stow
```
-Configs
--------
-
-#### Zsh Configuration
-
-- [zshrc](zshrc) - Zsh profile (sources [profile.sh](shell/profile.sh) & [zsh/*](zsh))
-- [starship.toml](starship.toml) - [starship](https://starship.rs/) cross-shell theme config
-- [shell/](sh) - Posix compliant cross-shell configs
- - [aliases.sh](shell/aliases.sh) - Alias definitions shared between shells
- - [gpg.sh](shell/gpg.sh) - Sets up the GPG agent bridges between wsl and windows
- - [profile.sh](shell/profile.sh) - Exports and Path additions shared between shells
- - [wsl.sh](shell/wsl.sh) - WSL2 specific config (sources [gpg.sh](shell/gpg.sh))
-- [zsh/](zsh) - Zsh configs
- - [aliases.zsh](zsh/aliases.zsh) - Alias definitions (sources [aliases.sh](zsh/aliases.zsh))
- - [antigen.zsh](zsh/antigen.zsh) - Loads Antigen plugins and theme
- - [keybindings.zsh](zsh/keybindings.zsh) - Keybindings and related functions
- - [prompt.zsh](zsh/prompt.zsh) - Prompt configuration and prompt theme settings
- - [setopt.zsh](zsh/setopt.zsh) - Zsh configuration settings
- - [wsl.zsh](zsh/wsl.zsh) - WSL2 specific config (sources [wsl.sh](shell/wsl.sh))
-
-#### Misc
-
-- [gitconfig](gitconfig) - Git configuration
-- [ssh/](ssh) - SSH related files
- - [config](ssh/config) - SSH configuration
- - [wsl2-ssh-pageant](ssh/wsl2-ssh-pageant.exe) - connects SSH/GPG sockets between WSL2 and Windows
-- [gnupg/](gnupg) - GnuPG (GPG) related files
- - [gpg.conf](gnupg/gpg.conf) - GPG configuration
- - [gpg-agent.conf](gnupg/gpg-agent.conf) - GPG-Agent configuration
- - [scdaemon.conf](gnupg/scdaemon.conf) - GPG smartcard daemon configuration
-
-Submodules
-----------
-
-- ### [Dotbot](https://github.com/anishathalye/dotbot) - A tool that bootstraps your dotfiles ⚡️
+Getting started
+---------------
-#### Zsh
+The configuration files are managed using gnu stow and make. The Makefile includes targets for stowing, un-stowing, and cleaning the symlinks. It also has targets for installing a selection of tools I use.
-- [antigen](https://github.com/zsh-users/antigen) - The plugin manager for zsh.
-- [fzf](https://github.com/junegunn/fzf) - 🌸 A command-line fuzzy finder
-- [p10k](https://github.com/romkatv/powerlevel10k) - A Zsh theme \ No newline at end of file
+Run `make interactive` or simply `make` to view and interactively select targets to install. \ No newline at end of file