Fix property name lookup

[android/external-libkmsxx.git] / README.md

diff --git a/README.md b/README.md
index 2190b7ad69b7188cde6d4db979c666912bcbadc2..374b63b0ed06707f1c121d756f6994ddbb97f028 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,14 @@
-# libkms++ - C++ library for kernel mode setting
+# kms++ - C++ library for kernel mode setting
 
-libkms++ is a C++11 library for kernel mode setting.
+kms++ is a C++11 library for kernel mode setting.
 
-Also included are some simple utilities for KMS and python bindings for libkms++.
+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
+- testpat - 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
 
@@ -20,6 +19,14 @@ Also included are some simple utilities for KMS and python bindings for libkms++
 
 ## 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
@@ -40,6 +47,25 @@ $ cmake -DCMAKE_TOOLCHAIN_FILE=<buildrootpath>/output/host/usr/share/buildroot/t
 $ 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 +73,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