aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorToby Vincent <tobyv13@gmail.com>2021-03-21 19:25:26 -0500
committerToby Vincent <tobyv13@gmail.com>2021-03-21 19:25:26 -0500
commitada31a22273ec68cff8d1362bc1be2f94dd5aa91 (patch)
tree2c8aec4a946a9ba257c3bdd49b0da6fec1a3b88a /README.md
parentd762fa216f12a573b55c2ad02feb3a49235326e8 (diff)
docs: added readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ba8a3e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# tobyvin's dotfiles
+
+### Installation
+
+```sh
+git clone --recursive https://github.com/tobyvin/dotfiles.git ~/dotfiles && ~/dotfiles/install
+```
+
+## Configs
+
+- **gitconfig**
+- **ssh/config**
+- **zshrc**: sources various config scripts and calls antigen to load plugins
+- **zsh/***: various zsh configuration scripts
+- **p10k.zsh**: zsh theme config
+- **antigen**: plugin manager that installs/updates zsh plugins
+- **fzf**: fuzzy finder that integrates with zsh history/autocompletion
+ \ No newline at end of file