aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIsaac Freund <ifreund@ifreund.xyz>2020-04-26 19:06:11 +0200
committerIsaac Freund <ifreund@ifreund.xyz>2020-04-26 19:06:11 +0200
commit809b2eeee1d2eb1d62da19281849167e791b1ad9 (patch)
tree25d0538e9c2ea796c16447b6e48e5a2e19546151 /README.md
parentc5826b04f41a05c6a631759c5a1d26211aaeef10 (diff)
downloadriver-809b2eeee1d2eb1d62da19281849167e791b1ad9.tar.gz
river-809b2eeee1d2eb1d62da19281849167e791b1ad9.tar.xz
Flesh out readme and fix typo
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4f31ea5..1fdef48 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,10 @@ river is a dynamic wayland compositor that takes inspiration from
[dwm](https://dwm.suckless.org) and
[bspwm](https://github.com/baskerville/bspwm).
-*Note: river is currently early in development and not yet ready for
-the average end user*
+*Note: river is currently early in development and may lack some
+features. If there are specific features blocking you from using river,
+don't hesitate to
+[open an issue](https://github.com/ifreund/river/issues/new)*
## Design goals
@@ -40,7 +42,8 @@ from a tty using KMS/DRM.
Keybinds are similar to the defaults of dwm, but using the "logo key"
instead of alt. Check out the comments in [config.zig](src/config.zig) for
a complete list of bindings. Note that the terminal emulator is currently
-hardcoded to [alacritty](https://github.com/alacritty/alacritty).
+hardcoded to [alacritty](https://github.com/alacritty/alacritty) but
+may be changed by editing [config.zig](src/config.zig) and recompiling.
## Development