From 809b2eeee1d2eb1d62da19281849167e791b1ad9 Mon Sep 17 00:00:00 2001 From: Isaac Freund Date: Sun, 26 Apr 2020 19:06:11 +0200 Subject: [PATCH] Flesh out readme and fix typo --- CONTRIBUTING.md | 2 +- README.md | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 029237d..fdc4c94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ ## Contributing to river Contributing is a simple as opening a pull request on our github. You'll likely -have find more success with your contribution if you hop on our +have more success with your contribution if you hop on our [matrix channel](https://matrix.to/#/#river:matrix.org) to discuss your plans first. 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