initialHEADmaster

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..719ab09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Ricebowl
+
+A bowl of delicous fine graned golden rice.
+
+- Scripts are in `~/.local/bin/`
+- Settings are in `~/.config`
+- Environmental variables are in `~/.zprofile` and `~/.config/x11/xprofile`
+- File bookmarks in `~/.config/shell/bm-files`
+- Directory bookmarks in `~/.config/shell/bm-dirs`
+
+## Usage
+
+These dotfiles are intended to go with numerous suckless programs I use:
+
+- [dwm](https://github.com/lukesmithxyz/dwm) (window manager)
+- [dwmblocks](https://github.com/lukesmithxyz/dwmblocks) (statusbar)
+- [st](https://github.com/lukesmithxyz/st) (terminal emulator)
+
+## Installation
+
+Use [SHARKS](https://shars.sh) to a guidea autoinstallation:
+
+```
+curl -LO sharks.sh/sharks.sh
+```
+
+or clone the repo files directly to your home directory and install the [dependencies](https://github.com/LukeSmithxyz/LARBS/blob/master/static/progs.csv).