diff --git a/README.md b/README.md
index 2190b7ad69b7188cde6d4db979c666912bcbadc2..c913e1ef56ea33452407f469a02c2e574f96c776 100644 (file)
--- a/README.md
+++ b/README.md
-# libkms++ - C++ library for kernel mode setting
+[![Build Status](https://travis-ci.org/tomba/kmsxx.svg?branch=master)](https://travis-ci.org/tomba/kmsxx)
-libkms++ is a C++11 library for kernel mode setting.
+# kms++ - C++ library for kernel mode setting
-Also included are some simple utilities for KMS and python bindings for libkms++.
+kms++ is a C++11 library for kernel mode setting.
+
+Also included are some simple utilities for KMS and python bindings for kms++.
## Utilities
-- testpat - set modes and planes and show test pattern on crtcs/planes
+- kmstest - set modes and planes and show test pattern on crtcs/planes, and test page flips
- kmsprint - print information about DRM objects
- kmsview - view raw images
-- db - simple double-buffering test
- kmscube - rotating 3D cube on crtcs/planes
- kmscapture - show captured frames from a camera on screen
## Build instructions:
+To build the Python bindings you need to set up the git-submodule for pybind11:
+
+```
+git submodule update --init
+```
+
+And to compile:
+
```
$ mkdir build
$ cd build
$ make -j4
```
+Your environment may provide similar toolchainfile. If not, you can create a toolchainfile of your own, something along these lines:
+
+```
+SET(CMAKE_SYSTEM_NAME Linux)
+
+SET(BROOT "<buildroot>/output/")
+
+# specify the cross compiler
+SET(CMAKE_C_COMPILER ${BROOT}/host/usr/bin/arm-buildroot-linux-gnueabihf-gcc)
+SET(CMAKE_CXX_COMPILER ${BROOT}/host/usr/bin/arm-buildroot-linux-gnueabihf-g++)
+
+# where is the target environment
+SET(CMAKE_FIND_ROOT_PATH ${BROOT}/target ${BROOT}/host)
+
+SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM ONLY)
+SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+```
+
## Build options
You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` to set them.
@@ -47,14 +75,15 @@ You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` t
Option name | Values | Default | Notes
--------------------- | ------------- | -------- | --------
CMAKE_BUILD_TYPE | Release/Debug | Release |
-LIBKMS_ENABLE_PYTHON | ON/OFF | ON |
-LIBKMS_ENABLE_KMSCUBE | ON/OFF | OFF |
+BUILD_SHARED_LIBS | ON/OFF | OFF |
+KMSXX_ENABLE_PYTHON | ON/OFF | ON |
+KMSXX_ENABLE_KMSCUBE | ON/OFF | OFF |
## Env variables
-You can use the following runtime environmental variables to control the behavior of libkms.
+You can use the following runtime environmental variables to control the behavior of kms++.
Variable | Description
--------------------------------- | -------------
-LIBKMSXX_DISABLE_UNIVERSAL_PLANES | Set to disable the use of universal planes
-LIBKMSXX_DISABLE_ATOMIC | Set to disable the use of atomic modesetting
+KMSXX_DISABLE_UNIVERSAL_PLANES | Set to disable the use of universal planes
+KMSXX_DISABLE_ATOMIC | Set to disable the use of atomic modesetting