aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..e364057
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,21 @@
+# River window manager configuration
+
+Configures riverwm, foot, swaylock, waybar and a couple of other bits.
+
+## Assumptions:
+
+ * My main [dotfiles](https://git.riedstra.dev/mitch/dotfiles/about/) are installed.
+ * Default shell is set to `oksh`. Bash and other shells probably work but are
+ untested
+ * Fedora 39
+
+
+Ideally cloned down to `~/scm/wl/rivercfg`, where you can run `./fedora.sh`
+from the directory and it'll setup everything. This includes fetching the latest
+copy of Zig and compiling river from source code.
+
+Once the command finishes without error you should be able to select `wlcustom`
+from the login manager ( gdm, sddm, etc )
+
+See `~/.waylandrc` and the [wlcustom](https://git.riedstra.dev/wl/wlcustom) repo
+for more information on customizing the session, environment variables, etc.