README

   1 = KMSCON =
   2 Kmscon is a simple terminal emulator based on linux kernel mode setting (KMS).
   3 It is an attempt to replace the in-kernel VT implementation with a userspace
   4 console.
   5
   6 == Requirements ==
   7   Kmscon requires the following software:
   8     - mesa with:
   9       - EGL library
  10       - gbm library
  11       - GL library
  12
  13 == Install ==
  14   To compile the kmscon binary, use:
  15     $ make
  16   There is currently no way to install the binary into your system.
  17
  18 == License ==
  19   This software is dedicated to the Public Domain. Feel free to modify it to
  20   your needs.
  21
  22 == FAQ ==
  23   === Why aren't you using GNU autotools? ===
  24   Feel free to send me patches. I will apply them immediately.
  25
  26   === Why didn't you use libvte or similar terminal emulators? ===
  27   All existing terminal emulators I found highly depend on X. Also, their code
  28   base often is a horrible mess. I haven't had the time to convert them to use
  29   other drawing functions than Xlib, yet.
  30   If you feel like doing this work, please notify me. I would be glad to adjust
  31   my code to work with other terminal emulators.
  32
  33 == Contact ==
  34   This software was written by:
  35     David Herrmann <dh.herrmann@googlemail.com>
  36   If you have any questions, do not hesitate to contact one of the developers.
  37
  38 == Code Base ==
  39   The kmscon code is split into several independent subsystems:
  40     - output:
  41       This code manages the KMS/DRI output and provides OpenGL framebuffers.
  42     - evdev:
  43       All linux input events are captured here and converted to Unicode
  44       characters for input handling.
  45     - vte:
  46       The terminal emulator library.
  47     - main:
  48       This connects all subsystems into a usable console application.