From 8373493ea6eb4c0c574048ce7b70aa5b0454293d Mon Sep 17 00:00:00 2001
From: Mikkel Svartveit <mikkel.svartveit@gmail.com>
Date: Tue, 21 Mar 2023 16:34:40 +0100
Subject: [PATCH] Add readme

---
 .gitignore |  3 ++-
 README.md  | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 61 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index b5e61c0..0a3cd72 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,7 +3,8 @@
 !*/
 
 # Whitelist certain files and directories
-!.gitignore
+!/.gitignore
+!/README.md
 !iterm2-preferences/**/*
 !fish/config.fish
 !git/**/*
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a7dfdda
--- /dev/null
+++ b/README.md
@@ -0,0 +1,59 @@
+# Configuration files for macOS
+
+A small collection of configuration files for macOS, including:
+
+- [iTerm2](https://iterm2.com) (terminal emulator)
+- [fish](https://fishshell.com) (shell)
+- Git
+- Neovim (complete development environment with Coc and a bunch of plugins)
+- Vim (simple configuration, no plugins)
+- [Karabiner](https://karabiner-elements.pqrs.org) (for [mapping CapsLock to Ctrl and Esc](https://medium.com/@pechyonkin/how-to-map-capslock-to-control-and-escape-on-mac-60523a64022b))
+- Some wallpapers and custom app icons
+
+## Setup
+
+#### Set up these config files
+
+```bash
+# Back up old config files (optional)
+cp -r ~/.config ~/.config_old
+
+# Set up this repository
+cd ~/.config
+git init
+git branch -m main
+git remote add origin git@github.com:mikkelsvartveit/dotfiles.git
+git fetch
+git reset --hard origin/main
+git branch --set-upstream-to=origin/main
+
+# Tell Vim to source from the right file
+echo "source ~/.config/vim/.vimrc" > .vimrc
+```
+
+#### Install software
+
+```bash
+# Install Homebrew
+/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
+
+# Install Homebrew packages
+brew install python fish git neovim ripgrep autojump thefuck
+
+# Install Node Version Manager and Node
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
+nvm install --lts
+nvm use --lts
+```
+
+#### Set up fish shell, oh-my-fish and plugins
+
+```bash
+fish
+fish_add_path /opt/homebrew/bin
+echo "/opt/homebrew/bin/fish" | sudo tee -a /etc/shells
+chsh -s /opt/homebrew/bin/fish
+curl https://raw.githubusercontent.com/oh-my-fish/oh-my-fish/master/bin/install | fish
+omf install bass
+omf install https://github.com/jhillyerd/plugin-git
+```