Commit 81bae4c4 authored by Lubosz Sarnecki's avatar Lubosz Sarnecki

README: Add contact, license and documentations sections. Add logo.

parent b0a37647
# xrdesktop
![xrdesktop Logo](doc/xrdesktop.png)
xrdesktop
=========
A library for XR interaction with classical desktop compositors.
......@@ -23,22 +26,27 @@ ninja -C build xrdesktop-doc
#### Run the examples
Run the scene client.
```
$ ./build/examples/client
```
Run the overlay client.
```
$ ./build/examples/client -o
```
#### Build gsettings for running without installing
To run the client example without xrdesktop being installed, you need to
build the glib schemas in `res`
```
$ glib-compile-schemas res/
```
And add the `GSETTINGS_SCHEMA_DIR`
```
$ GSETTINGS_SCHEMA_DIR=res/ ./build/examples/client
```
......@@ -47,25 +55,43 @@ $ GSETTINGS_SCHEMA_DIR=res/ ./build/examples/client
#### Run the tests
Run all tests
```
$ ninja -C build test
```
Don't run tests that require a running XR runtime.
```
meson test -C build/ --no-suite xrdesktop:xr
```
Don't run tests that require a running XR runtime or the installed package.
```
meson test -C build/ --no-suite xrdesktop:xr --no-suite xrdesktop:post-install
```
Since meson `0.46` the project name can be omitted from the test suite:
```
meson test -C build/ --no-suite xr --no-suite post-install
```
## Contact
You can submit issues in our [issue tracker](https://gitlab.freedesktop.org/xrdesktop/xrdesktop/issues).
Join our chats, *#xrdesktop* on freenode or [Discord](https://discord.gg/msETben).
## Documentation
For getting started read the [Howto Guide](https://gitlab.freedesktop.org/xrdesktop/xrdesktop/wikis/howto) in our wiki. We also have a generated [API documentation](https://xrdesktop.freedesktop.org/doc/).
## License
xrdesktop is licensed under MIT.
## Code of Conduct
Please note that this project is released with a Contributor Code of Conduct.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment