kmscon/README
David Herrmann ca409fb0c5 Update documentation about autotools
Signed-off-by: David Herrmann <dh.herrmann@googlemail.com>
2011-12-02 13:31:12 +01:00

56 lines
1.8 KiB
Plaintext

= KMSCON =
Kmscon is a simple terminal emulator based on linux kernel mode setting (KMS).
It is an attempt to replace the in-kernel VT implementation with a userspace
console.
== Requirements ==
Kmscon requires the following software:
- mesa with:
- EGL library
- gbm library
- GL library
- pango with:
- glib
- cairo
- pango
== Install ==
To compile the kmscon binary, run the standard autotools commands:
$ ./configure [--enable-debug]
$ make
$ make install
To compile the test applications, run:
$ make check
== License ==
This software is licensed under the terms of the MIT license. Please see
./COPYING for further information.
== FAQ ==
=== Why didn't you use libvte or similar terminal emulators? ===
All existing terminal emulators I found highly depend on X. Also, their code
base often is a horrible mess. I haven't had the time to convert them to use
other drawing functions than Xlib, yet.
If you feel like doing this work, please notify me. I would be glad to adjust
my code to work with other terminal emulators.
== Contact ==
This software was written by:
David Herrmann <dh.herrmann@googlemail.com>
If you have any questions, do not hesitate to contact one of the developers.
== Code Base ==
The kmscon code is split into several independent subsystems:
- output:
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
emulator to visualize its contents.
- evdev:
All linux input events are captured here and converted to Unicode
characters for input handling.
- vte:
The terminal emulator library.
- main:
This connects all subsystems into a usable console application.