From 7f46d3087461c205ba9c5b9523017c1d7682a958 Mon Sep 17 00:00:00 2001
From: Anton <aligator.h0spital.e@gmail.com>
Date: Sun, 4 Aug 2024 08:59:14 +0200
Subject: [PATCH] feat: Add a README.md

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..626e7ed
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+<!-- @format -->
+
+# Anton's dotfiles
+
+These are my dotfiles for zsh, i3, neovim, and kitty. All stored using the GNU stow applet.
+
+To install these dotfiles and use them as your own, simply install GNU stow:
+
+```bash
+$ sudo pacman -S stow
+```
+
+clone this repository to your home directory:
+
+```bash
+$ git clone --depth=1 https://github.com/antonw51/dotfiles ~/dotfiles
+```
+
+then use the `stow` command:
+
+```bash
+$ stow ~/dotfiles
+```
+
+## Oh-my-zsh
+
+The zsh config present here relies on oh-my-zsh, you can install that with curl:
+
+```bash
+$ sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
+```
+
+Then install the dependencies:
+
+- zsh-syntax-highlighting:
+
+```bash
+$ git clone https://github.com/zsh-users/zsh-syntax-highlighting.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-syntax-highlighting
+```
+
+- zsh-completion:
+
+```bash
+$ git clone https://github.com/zsh-users/zsh-completions ${ZSH_CUSTOM:-${ZSH:-~/.oh-my-zsh}/custom}/plugins/zsh-completions
+```