diff options
| author | Drew DeVault <sir@cmpwn.com> | 2018-10-12 08:27:09 -0400 |
|---|---|---|
| committer | Drew DeVault <sir@cmpwn.com> | 2018-10-12 08:27:09 -0400 |
| commit | 4c28745c95688fcee9b70ad746faeb91aca26298 (patch) | |
| tree | fc01ec89877d02c5d55e52a91344ddf6aa648a29 /README.md | |
| parent | 66e8908e9ad5027934537a6e7f641ba3a74637e2 (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 4 insertions, 3 deletions
@@ -30,8 +30,8 @@ development tools - or any subset of these features you like, because all of them work independently of one another and freely compose with anything you want to implement yourself. -**Status**: prior to 1.0 the API is not stable, but we've done most of the work -and various projects are using wlroots to build Wayland compositors with. +Check out our [wiki](https://github.com/swaywm/wlroots/wiki/Getting-started) to +get started with wlroots. wlroots is developed under the direction of the [sway](https://github.com/swaywm/sway) project. A variety of wrapper libraries @@ -83,7 +83,8 @@ Install like so: wlroots comes with a test compositor called rootston, which demonstrates the features of the library and is used as a testbed for the development of the library. It may also be useful as a reference for understanding how to use -various wlroots features. +various wlroots features, but it's not considered a production-quality codebase +and is not designed for daily use. If you followed the build instructions above the rootston executable can be found at `./build/rootston/rootston`. To use it, refer to the example config at |