diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2021-07-17 16:10:07 +0200 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2021-07-17 16:10:07 +0200 |
| commit | d6ad06ae87ebc600996975f73313e2439f216c7f (patch) | |
| tree | ee4d9b0111d27556d950421b96a01c17a60a5251 /README.md | |
| parent | 0063c722e55cec4c8e83b0c1ef2c818006d3eb41 (diff) | |
| download | river-d6ad06ae87ebc600996975f73313e2439f216c7f.tar.gz river-d6ad06ae87ebc600996975f73313e2439f216c7f.tar.xz | |
docs: simplify README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 5 insertions, 14 deletions
@@ -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 |