]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - android/external-libkmsxx.git/blobdiff - README.md
py: add missing pixelformats
[android/external-libkmsxx.git] / README.md
index a3e1077b84d1dea36df6f88b71e04acc6c9d1336..a94de9ca8a308825238ca7f15d27b8840b414a58 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
 
@@ -55,14 +54,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