graphlcd-base/README
changeset 4 df6a40031aa5
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/graphlcd-base/README	Wed Feb 06 17:32:55 2008 +0000
     1.3 @@ -0,0 +1,97 @@
     1.4 +This is the base package of the GraphLCD project. It contains
     1.5 + - GraphLCD driver library - libglcddrivers
     1.6 + - GraphLCD graphics library - libglcdgraphics
     1.7 + - GraphLCD tools (crtfont, convpic, showpic, showtext)
     1.8 + - GraphLCD media files (pictures and splash screens in GLCD format, fonts)
     1.9 +
    1.10 +written by Andreas Regel (andreas.regel AT powarman.de)
    1.11 +
    1.12 +based on the graphlcd plugin for the Video Disc Recorder
    1.13 +  written by                   Carsten Siebholz (c.siebholz AT t-online.de)
    1.14 +  from 0.0.8 on maintained by  Andreas Regel (andreas.regel AT powarman.de)
    1.15 +    gu140x32f driver by        Andreas Brachold (vdr04 AT deltab.de)
    1.16 +    gu256x64-372 driver by     Andreas Weinberger (vdr AT smue.org)
    1.17 +    gu256x64-3xx0 driver by    Ralf Mueller (ralf AT bj-ig.de)
    1.18 +    gu126x64D-K610A4 driver by Alexander Rieger (Alexander.Rieger AT inka.de)
    1.19 +    image driver by            Andreas Regel (andreas.regel AT powarman.de)
    1.20 +    ks0108 driver by           Andreas Weinberger (vdr AT smue.org)
    1.21 +    sed1330 driver by          Roland Praml (praml.roland AT t-online.de)
    1.22 +                               Heinz Gressenberger (heinz.gressenberger AT stmk.gv.at)
    1.23 +    sed1520 driver by          Andreas Weinberger (vdr AT smue.org)
    1.24 +    framebuffer driver by      Stephan Skrodzki (skrodzki AT stevekist.de)
    1.25 +    serdisplib driver by       Wolfgang Astleitner (mrwastl AT users.sourceforge.net)
    1.26 +    t6963c driver by           Andreas Regel (andreas.regel AT powarman.de)
    1.27 +    noritake800 drider by      Lucian Muresan (lucianm AT users.sourceforge.net)
    1.28 +
    1.29 +
    1.30 +Project's homepage: http://graphlcd.berlios.de/
    1.31 +
    1.32 +
    1.33 +See the file COPYING for license information.
    1.34 +
    1.35 +
    1.36 +Description
    1.37 +-----------
    1.38 +The GraphLCD base is a project to support graphical LC displays. It is
    1.39 +mainly used by the graphlcd plugin for the Video Disc Recorder to
    1.40 +display its information.
    1.41 +
    1.42 +The GraphLCD driver library supports the following LCD
    1.43 +controllers/modules:
    1.44 + - Hitachi HD61830
    1.45 + - Toshiba T6963
    1.46 + - Samsung KS0108
    1.47 + - Epson SED1520 (only tested with DIP122 lcd module)
    1.48 + - Epson SED1330
    1.49 + - Noritake GU140X32F-7806
    1.50 + - Noritake GU256X64-372
    1.51 + - Noritake GU256X64-3XX0 (serial or parallel)
    1.52 + - Noritake GU126x64D-K610A4 displays (parallel)
    1.53 + - Noritake 800 series displays
    1.54 + - all controllers supported by serdisplib (http://serdisplib.sourceforge.net)
    1.55 +
    1.56 +Other controllers might be supported in the future.
    1.57 +
    1.58 +Additionally the GraphLCD driver library includes some special drivers:
    1.59 + - framebuffer, for devices that are connected to the VGA connector
    1.60 + - image, for writing image sequences in PBM (Portable Bit Map) format that
    1.61 +   show the plugin's output.
    1.62 +
    1.63 +
    1.64 +Installation and Configuration:
    1.65 +-------------------------------
    1.66 +1. Unpack the tarball to an arbitrary directory.
    1.67 +
    1.68 +  tar xzf graphlcd-base-0.1.2.tgz
    1.69 +
    1.70 +2. Configure if you want FreeType2 support by commenting/uncommenting
    1.71 +   HAVE_FREETYPE2 in Make.config.
    1.72 +
    1.73 +3. Compile the libraries and tools.
    1.74 +
    1.75 +  make all (from the package's directory)
    1.76 +
    1.77 +4. Install the libraries and tools.
    1.78 +
    1.79 +  make install (from the package's directory)
    1.80 +
    1.81 +5. Edit the configuration file graphlcd.conf to fit your needs.
    1.82 +
    1.83 +6. Copy it to the GraphLCD's default configuration search path (/etc).
    1.84 +
    1.85 +  cp graphlcd.conf /etc
    1.86 +
    1.87 +
    1.88 +Notes about FreeType2:
    1.89 +----------------------
    1.90 +If the HAVE_FREETYPE2 variable is defined, then the new method
    1.91 +cFont::LoadFT2(..) from the graphics library will load a FreeType2-supported
    1.92 +font (only TTFs tested so far) and render it into the raster font structure
    1.93 +that cFont uses normally. The method is also defined if no FT2 support is
    1.94 +compiled in, only then it will return false afer logging an error message in
    1.95 +the system log, telling that graphlcd-base has been compiled without FT2
    1.96 +support. This way, applications using this library (vdrplugin-graphlcd, or the
    1.97 +wrapper LCDproc "meta-driver" glcdprocdriver for example, can treat this case
    1.98 +and have a fallback to the glcdraphics-native raster font if FT2 is not
    1.99 +supported, or the TTF font could not be loaded for some reason.
   1.100 +