mirrors/wlroots
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wlroots/wlroots.git synced 2025-12-15 08:56:26 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update READMEs per tinywl merge

Browse source
This commit is contained in:
Drew DeVault 2019-01-03 10:10:03 -05:00
parent fc2ba30cfa
commit f0d8b793a8
5 changed files with 53 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -78,21 +78,6 @@ Install like so:
sudo ninja -C build install
## Running the test compositor
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, 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
[./rootston/rootston.ini.example](https://github.com/swaywm/wlroots/blob/master/rootston/rootston.ini.example)
and place a config file of your own at `rootston.ini` in the working directory
(or in an arbitrary location via `rootston -C`). Other options are available,
refer to `rootston -h`.
## Contributing
See [CONTRIBUTING.md](https://github.com/swaywm/wlroots/blob/master/CONTRIBUTING.md).