diff --git a/README.md b/README.md
index ea3cd24f7432e9d7fa97b0705fe6837096401d89..1d20a52271f4d98707a36de7395103b179ce558f 100644 (file)
--- a/README.md
+++ b/README.md
libkms++ is a C++11 library for kernel mode setting.
libkms++ is a C++11 library for kernel mode setting.
-Also included are simple test tools for KMS and python and lua wrappers for libkms++.
+Also included are simple test tools for KMS and python wrapper for libkms++.
+
+## Test tools
+
+- kmsprint - print information about DRM objects
+- testpat - set modes and show test pattern on crtcs/planes
+- kmsview - view raw images
+- db - simple double-buffering test
+- kmscube - rotating 3D cube on crtcs/planes
## Dependencies:
- libdrm
## Dependencies:
- libdrm
-- SWIG 3.x (for python & lua bindings)
+- SWIG 3.x (for python bindings)
- Python 3.x (for python bindings)
- Python 3.x (for python bindings)
-- Lua 5.x (for lua bindings)
## Build instructions:
## Build instructions:
You can use the following cmake flags to control the build. Use `-DFLAG=VALUE` to set them.
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 |
+LIBKMS_ENABLE_PYTHON | ON/OFF | ON |
+LIBKMS_ENABLE_KMSCUBE | ON/OFF | OFF |
+LIBKMS_ENABLE_LTO | ON/OFF | OFF | Link Time Optimization
+
+## Env variables
+
+You can use the following runtime environmental variables to control the behavior of libkms.
+
+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