add zshrc and update readme

README.md

@@ -1,2 +1,21 @@
 ### Dotfiles
-This is a repo for all the various config files
+
+This is a repo for all the various config files
+
+## Configs
+
+- hyprpaper: wallpaper manager for hyprland
+    - the `backgrounds` directory is needed for this
+- hyprlock: this is the lock screen
+    - the `hyprmocha` directory is needed for this to colour it correctly
+- kitty: the prefered terminal emulator
+- nvim: all the config and plugins to lazy and nvim
+- starship: the command prompt style
+- wofi: the program launcher
+- waybar: this bar at the top of the screen
+
+## How to use
+
+1. Install `stow` via pacman, this is a package that quickly sets up sym links in the file system to the folder structure in this repo based on the root directory
+2. use `stow` to setup the sym links, e.g. `stow hyprlock` or `stow backgrounds`
+3. done, restart the tool/service if needed

zshrc/.zshrc

@@ -0,0 +1,38 @@
+
+eval "$(starship init zsh)"
+
+# Enable Powerlevel10k instant prompt. Should stay close to the top of ~/.zshrc.
+# Initialization code that may require console input (password prompts, [y/n]
+# confirmations, etc.) must go above this block; everything else may go below.
+# if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
+#   source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
+# fi
+
+# If you come from bash you might have to change your $PATH.
+# export PATH=$HOME/bin:$HOME/.local/bin:/usr/local/bin:$PATH
+
+# Path to your Oh My Zsh installation.
+export ZSH="$HOME/.oh-my-zsh"
+
+# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
+# ZSH_THEME="powerlevel10k/powerlevel10k"
+
+# Which plugins would you like to load?
+# Standard plugins can be found in $ZSH/plugins/
+# Custom plugins may be added to $ZSH_CUSTOM/plugins/
+# Example format: plugins=(rails git textmate ruby lighthouse)
+# Add wisely, as too many plugins slow down shell startup.
+plugins=(git)
+
+source $ZSH/oh-my-zsh.sh
+
+export EDITOR='nvim'
+
+# ALIASES
+
+alias c='clear'
+
+
+# To customize prompt, run `p10k configure` or edit ~/.p10k.zsh.
+# [[ ! -f ~/.p10k.zsh ]] || source ~/.p10k.zsh
+