From 38395dbe0fccacd33df96b5b054583333179098f Mon Sep 17 00:00:00 2001
From: Wesley Kerfoot <wjak56@gmail.com>
Date: Sun, 19 Jan 2020 22:12:38 -0500
Subject: [PATCH] Add a readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a4b912
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+## BouncyWM
+
+### What is this?
+
+My solution to [https://jvns.ca/blog/2019/11/25/challenge--make-a-bouncy-window-manager/](https://jvns.ca/blog/2019/11/25/challenge--make-a-bouncy-window-manager/) in Nim.
+
+### How to build it?
+Install nim and nimble and run `nimble build`. You must have XLib development headers on your system (and obviously an X server).
+
+### How to run it?
+```
+Xephyr -ac -screen 1280x1024 -br -reset -terminate 2> /dev/null :1 &
+env DISPLAY=:1 ./nimwin
+```
+
+### How to launch a window?
+If you want to run xterm, for example, just run `xterm -display :1`