Modify it to adjust Tizen IVI enviroment

[platform/upstream/kmscon.git] / README

diff --git a/README b/README
index 1b36cd6..da1290f 100644 (file)
--- a/README
+++ b/README
@@ -4,11 +4,20 @@ 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. See kmscon(1) man-page for usage information.
 
+Website:
+  http://www.freedesktop.org/wiki/Software/kmscon
+
 == Requirements ==
 
   Kmscon requires the following software:
+    - libtsm: terminal emulator state machine
+        http://www.freedesktop.org/wiki/Software/kmscon/libtsm/
     - libudev: providing input, video, etc. device hotplug support (>=v172)
+        http://www.freedesktop.org/wiki/Software/systemd/
     - libxkbcommon: providing internationalized keyboard handling
+        http://xkbcommon.org/
+    - libdrm: graphics access to DRM/KMS subsystem
+    - linux-headers: linux kernel headers for ABI definitions
 
   Everything else is optional:
 
@@ -30,6 +39,11 @@ console. See kmscon(1) man-page for usage information.
     For multi-seat support you need the following packages:
       - systemd: Actually only the systemd-logind daemon and library is required.
 
+== Download ==
+
+Released tarballs can be found at:
+  http://www.freedesktop.org/software/kmscon/releases
+
 == Install ==
 
   To compile the kmscon binary, run the standard autotools commands:
@@ -50,11 +64,8 @@ console. See kmscon(1) man-page for usage information.
   explicitly enable it via command line:
     --enable-multi-seat: This requires the systemd-logind library to provide
                          multi-seat support for kmscon. [default: on]
-    --enable-hotplug: This requires libudev for hotplugging support. This is
-                      currently mandatory and cannot be disabled. [default: on]
     --enable-debug: Enable debug mode/messages [default: on]
     --enable-optimizations: Enable code optimizations [default: on]
-    --enable-eloop-dbus: Build dbus extension for eloop library [default: off]
 
   Backends for several subsystems in kmscon can be selected with the following
   options (all of them take a comma-separated list of backend names):
@@ -65,31 +76,18 @@ console. See kmscon(1) man-page for usage information.
        Default is: fbdev,drm2d,drm3d
     --with-fonts: Font renderers. Available backends are:
        - unifont: Static built-in non-scalable font (Unicode Unifont)
-       - freetype2: Freetype2+fontconfig based scalable font renderer
        - pango: Pango based scalable font renderer
        Default is: unifont,pango
        The 8x16 backend is always built-in.
     --with-renderers: Console rendering backends. Available are:
        - bbulk: Simple 2D software-renderer (bulk-mode)
        - gltex: OpenGLESv2 accelerated renderer
-       - cairo: cairo based renderer
        - pixman: pixman based renderer
        Default is: bbulk,gltex
        The bblit backend is always built-in.
     --with-sessions: Built in sessions. Available sessions are:
        - dummy: Dummy fallback session
        - terminal: Terminal-emulator sessions
-       - cdev: Fake VTs via CUSE (DEPRECATED! Don't use it!)
-
-  The following options select which applications are built. If
-  dependency-checks fail, they are disabled by default unless explicitly enabled
-  on the command line:
-    --enable-kmscon: Build kmscon application [default: on]
-    --enable-wlterm: Build wlterm Wayland terminal [default: off]
-    --enable-eloop: Build eloop event loop library [default: off]
-    --enable-tsm: Build TSM terminal state-machine library [default: off]
-    --enable-uterm: Build uterm library [default: off]
-    --enable-uvt: Build UVT library [default: off]
 
 == Running ==
 
@@ -109,10 +107,10 @@ console. See kmscon(1) man-page for usage information.
 
 == FAQ ==
 
-  Please see http://github.com/dvdhrm/kmscon/wiki
+  Please see: http://www.freedesktop.org/wiki/Software/kmscon
 
 == Contact ==
 
   This software is maintained by:
-    David Herrmann <dh.herrmann@googlemail.com>
+    David Herrmann <dh.herrmann@gmail.com>
   If you have any questions, do not hesitate to contact one of the maintainers.