Skip to content

Commit

Permalink
docs: simplify README
Browse files Browse the repository at this point in the history
  • Loading branch information
ifreund committed Jul 17, 2021
1 parent 0063c72 commit d6ad06a
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit d6ad06a

Please sign in to comment.