aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 4 insertions, 6 deletions
diff --git a/README.md b/README.md
index 08844313..1519d0b3 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -74,9 +74,6 @@ Run these commands:
meson build
ninja -C build
-On FreeBSD, you need to pass an extra flag to prevent a linking error:
-`meson build -D b_lundef=false`.
-
Install like so:
sudo ninja -C build install
@@ -86,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