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

docs: simplify README

Browse source
This commit is contained in:
Isaac Freund 2021-07-17 16:10:07 +02:00
parent 0063c722e5
commit d6ad06ae87
No known key found for this signature in database
GPG key ID: 86DED400DDFD7A11
1 changed files with 5 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,8 +1,10 @@
# river
river is a dynamic tiling wayland compositor that takes inspiration from
[dwm](https://dwm.suckless.org) and
[bspwm](https://github.com/baskerville/bspwm).
River is a dynamic tiling wayland compositor with flexible runtime
configuration.
Join us at [#river](https://web.libera.chat/?channels=#river)
on irc.libera.chat. Read our [wiki](https://github.com/ifreund/river/wiki).
*Note: river is currently early in development. Expect breaking changes
and missing features. If you run into a bug don't hesitate to
@ -69,17 +71,6 @@ in the example directory.
For complete documentation see the `river(1)`, `riverctl(1)`, and
`rivertile(1)` man pages.
As a supplement to the man pages, see also the [FAQ](https://github.com/ifreund/river/wiki#faq)
in the wiki for common issues and have a look at the [recommended
software](https://github.com/ifreund/river/wiki/Recommended-Software).
## Development
If you are interested in the development of river, please join us at
[#river](https://web.libera.chat/?channels=#river) on irc.libera.chat. You
should also read [CONTRIBUTING.md](CONTRIBUTING.md) if you intend to submit
patches.
## Licensing
river is released under the GNU General Public License version 3, or (at your