diff --git a/README.md b/README.md
index bf1e44a9d7d3bbe261f755c27fa6abf94991ff7c..f0f3b97dea67e03bbf972c04ff6fdb788bb98627 100644 (file)
--- a/README.md
+++ b/README.md
-# libkms++ - C++ library for kernel mode setting
+[](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 simple test tools for KMS and python and lua wrappers 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
+
+- 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
+- kmscube - rotating 3D cube on crtcs/planes
+- kmscapture - show captured frames from a camera on screen
## Dependencies:
- libdrm
-- SWIG 3.x (for python & lua bindings)
- Python 3.x (for python bindings)
-- Lua 5.x (for lua bindings)
## 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
## Cross compiling instructions:
-Directions for cross compiling depend on your environment. These are for mine (buildroot):
+Directions for cross compiling depend on your environment.
-As above, but specify `-DCMAKE_TOOLCHAIN_FILE=<path>/your-toolchain.cmake` for cmake, where your-toolchain.cmake is something similar to:
+These are for mine with buildroot:
+
+```
+$ mkdir build
+$ cd build
+$ cmake -DCMAKE_TOOLCHAIN_FILE=<buildrootpath>/output/host/usr/share/buildroot/toolchainfile.cmake ..
+$ 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)
You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` to set them.
-Option name | Values | Default
--------------------- | ------------- | --------
-CMAKE_BUILD_TYPE | Release/Debug | Release
-LIBKMS_ENABLE_PYTHON | ON/OFF | ON
-LIBKMS_ENABLE_LUA | ON/OFF | ON
+Option name | Values | Default | Notes
+--------------------- | ------------- | --------------- | --------
+CMAKE_BUILD_TYPE | Release/Debug | Release |
+BUILD_SHARED_LIBS | ON/OFF | OFF |
+KMSXX_ENABLE_PYTHON | ON/OFF | ON |
+KMSXX_ENABLE_KMSCUBE | ON/OFF | OFF |
+KMSXX_PYTHON_VERSION | python3/python2 | python3;python2 | Name of the python pkgconfig file
## Env variables
-You can use the following 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
+
+## Python notes
+
+You can run the python code directly from the build dir by defining PYTHONPATH env variable. For example:
+
+```
+PYTHONPATH=build/py py/tests/hpd.py
+
+```