diff options
| author | David Herrmann <dh.herrmann@googlemail.com> | 2012-03-27 16:48:27 +0200 |
|---|---|---|
| committer | David Herrmann <dh.herrmann@googlemail.com> | 2012-03-27 16:48:27 +0200 |
| commit | 1648c9101b3b70331aa11ba73da066df64bd0868 (patch) | |
| tree | bbcbb57010772fded8aa5f91a5658989862584c2 | |
| parent | f02d74592821dc1ddfcdb47adfb72b105ff13556 (diff) | |
Update README
Fix some small typos and add TODOs.
Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
| -rw-r--r-- | README | 18 |
1 files changed, 13 insertions, 5 deletions
@@ -8,11 +8,11 @@ console. - libdrm: accessing the kernel graphics layer - mesa: providing an OpenGL implementation (must be compiled with EGL, gbm and GL libraries) - - udev: providing input device hotplug - - xproto (build time dependency): definition of key symbols + - udev: providing input, video, etc. hotplug support + - xproto (build time dependency): definition of keysymbols (TODO: remove it) - libxkbcommon: keyboard handling (optional but strongly recommended) Without libxkbcommon, basic US-ASCII input is provided. - - glib: only for Unicode handling + - glib: only for Unicode handling (TODO: remove it) - One of: - freetype2: drawing generic text - pango: drawing text with pango (use --enable-pango) @@ -22,10 +22,18 @@ console. To compile the kmscon binary, run the standard autotools commands: $ ./configure [--enable-debug] [--enable-pango] $ make - $ make install + $ make install (TODO: this is currently not supported) To compile the test applications, run: $ make check +== Running == + To get usage information, run: + $ ./kmscon --help + You can then run kmscon with: + $ ./kmscon [options] --switchvt + The --switchvt option will make your machine switch the active VT directly to + kmscon after starting it. + == License == This software is licensed under the terms of the MIT license. Please see ./COPYING for further information. @@ -45,7 +53,7 @@ console. == Code Base == The kmscon code is split into several independent subsystems: - - output: + - uterm: This code manages the KMS/DRI output and provides OpenGL framebuffers. - console: This draws the text on the screen and provides an API for any terminal |