Nulo/river
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Flesh out readme and fix typo

Browse source
This commit is contained in:
Isaac Freund 2020-04-26 19:06:11 +02:00
parent c5826b04f4
commit 809b2eeee1
No known key found for this signature in database
GPG key ID: 86DED400DDFD7A11
2 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -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.

9
README.md
View file

@ -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