diff --git a/README.md b/README.md deleted file mode 100644 index b1ad9e7..0000000 --- a/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# .stumpwm.d - -My temporary StumpWM config until it becomes a literary config. \ No newline at end of file diff --git a/README.org b/README.org new file mode 100644 index 0000000..bbf0f6a --- /dev/null +++ b/README.org @@ -0,0 +1,16 @@ +* .stumpwm.d +This is my temporary StumpWM config until it becomes a literary config +in my main dotfiles repo. + +To install this config, simply clone this repository in your home +directory. You can also clone it in any directory you’d like and run +the following command (just make sure ~~/.stumpwd.d/~ doesn’t already +exist) +#+begin_src shell + ln -s path/to/your/git/clone ~/.stumpwm.d/ +#+end_src + +If you are lost with the keybindings, refere to +[[file:./keybindings.lisp]]. Keybindings bound to ~*top-map*~ are +immediately available, those bound to ~*root-map*~ are available through +~s-SPC~.