Update README

Fix some small typos and add TODOs.

Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
This commit is contained in:
David Herrmann 2012-03-27 16:48:27 +02:00
parent f02d745928
commit 1648c9101b

18
README
View File

@ -8,11 +8,11 @@ console.
- libdrm: accessing the kernel graphics layer - libdrm: accessing the kernel graphics layer
- mesa: providing an OpenGL implementation (must be compiled with EGL, gbm - mesa: providing an OpenGL implementation (must be compiled with EGL, gbm
and GL libraries) and GL libraries)
- udev: providing input device hotplug - udev: providing input, video, etc. hotplug support
- xproto (build time dependency): definition of key symbols - xproto (build time dependency): definition of keysymbols (TODO: remove it)
- libxkbcommon: keyboard handling (optional but strongly recommended) - libxkbcommon: keyboard handling (optional but strongly recommended)
Without libxkbcommon, basic US-ASCII input is provided. Without libxkbcommon, basic US-ASCII input is provided.
- glib: only for Unicode handling - glib: only for Unicode handling (TODO: remove it)
- One of: - One of:
- freetype2: drawing generic text - freetype2: drawing generic text
- pango: drawing text with pango (use --enable-pango) - pango: drawing text with pango (use --enable-pango)
@ -22,10 +22,18 @@ console.
To compile the kmscon binary, run the standard autotools commands: To compile the kmscon binary, run the standard autotools commands:
$ ./configure [--enable-debug] [--enable-pango] $ ./configure [--enable-debug] [--enable-pango]
$ make $ make
$ make install $ make install (TODO: this is currently not supported)
To compile the test applications, run: To compile the test applications, run:
$ make check $ 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 == == License ==
This software is licensed under the terms of the MIT license. Please see This software is licensed under the terms of the MIT license. Please see
./COPYING for further information. ./COPYING for further information.
@ -45,7 +53,7 @@ console.
== Code Base == == Code Base ==
The kmscon code is split into several independent subsystems: The kmscon code is split into several independent subsystems:
- output: - uterm:
This code manages the KMS/DRI output and provides OpenGL framebuffers. This code manages the KMS/DRI output and provides OpenGL framebuffers.
- console: - console:
This draws the text on the screen and provides an API for any terminal This draws the text on the screen and provides an API for any terminal