aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemse2020-04-16 23:34:21 -0700
committerGravatar Tom Willemse2020-04-16 23:34:21 -0700
commit893de6fce3528d1b30ac9a7d397ee8c78b7b758c (patch)
tree93162c1f78e68c3dd60d59fa071c9eb226a9d1a4
parent0313e5ade5bffc92ac43d5ce39d5affc6d74df8a (diff)
downloadstumpwm-893de6fce3528d1b30ac9a7d397ee8c78b7b758c.tar.gz
stumpwm-893de6fce3528d1b30ac9a7d397ee8c78b7b758c.zip
Add initial README
-rw-r--r--README.org22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..461e18b
--- /dev/null
+++ b/README.org
@@ -0,0 +1,22 @@
+#+TITLE: StumpWM Configuration
+
+This is my configuration for [[https://stumpwm.github.io/][StumpWM]].
+
+* Installation
+
+ I use [[https://ellipsis.sh/][Ellipsis]] to install this configuration.
+
+ #+begin_example
+ ellipsis install git://ryuslash.org/dot/tom/stumpwm
+ #+end_example
+
+ On install it will try and clone [[https://github.com/stumpwm/stumpwm-contrib][stumpwm-contrib]] into =~/.stumpwm.d/modules=,
+ which is the recommended location for StumpWM modules to live, so it can
+ reference the modules in this configuration.
+
+* Dependencies
+
+ This configuration requires the following QuickLisp packages on top of StumpWM
+ and stumpwm-contrib:
+
+ - swank