README

   1 -- INTRODUCTION --------------------------------------------------------------
   2
   3 LCDproc is a client/server suite including drivers for all kinds of nifty LCD
   4 devices. The server works with different display sizes and supports several
   5 serial devices: Matrix Orbital, Crystal Fontz, Bayrad, LB216, LCDM001
   6 (kernelconcepts.de), Wirz-SLI and PIC-an-LCD; some devices connected to
   7 the parallel port: HD44780, STV5730, T6963, SED1520 and SED1330; and also
   8 some displays connected via USB: CFontzPacket, CwLnx, IOWarrior, LIS2 and
   9 BWCT.
  10 Various clients are available that display things like CPU load, system load,
  11 memory usage, uptime, and a lot more.
  12
  13 LCDproc also supports key or remote control input for controlling the clients.
  14
  15 The client and the server use a TCP connection to communicate, so it is
  16 possible to have a client on a box in Sweden showing its stats on a LCD
  17 display in the United States.
  18
  19 Our web site is located at http://lcdproc.org/
  20 For new versions and CVS go to http://sourceforge.net/projects/lcdproc/
  21
  22 Check there first for new versions or updates. For remaining questions,
  23 you can ask the mailing list. For how to get on the mailing list, see
  24 the main web site.
  25
  26 LCDproc was originally written by William W. Ferrell <wwf@splatwerks.org>
  27 and Scott Scriven <scriven@cs.colostate.edu>.
  28
  29 -- INSTALLATION --------------------------------------------------------------
  30
  31 Refer to the INSTALL file included with this archive for installation
  32 instructions (including how to connect the LCD to your system).
  33
  34 -- CHANGES -------------------------------------------------------------------
  35
  36 Woow...  a lot.  :)
  37 See the ChangeLog file for more details.
  38
  39 -- HELPING OUT ---------------------------------------------------------------
  40
  41 The first thing you should do is join the mailing list, to do so, go to out
  42 web site and click on MAIL and follow the instructions.
  43
  44 If you get the urge to help out by writing code, take a look at the TODO
  45 file to see what we think that needs to be done. If you want to work on
  46 something, or you want to add something different, tell it on the
  47 mailing list. Maybe someone is already working on the part, and maybe someone
  48 has already writen something that you can use. New ideas are always welcome !
  49
  50 To learn more about how LCDproc works, first have a look at the docs/
  51 directory. Some important things are documented there, but because this is
  52 still somewhat a big hacking project, some documentation will be missing ;)
  53
  54 -- SPECIAL THANKS ------------------------------------------------------------
  55
  56 LCDproc is a community effort, and as such we'd like to recognize everyone's
  57 efforts. We've tried to list all the people that have contributed in the
  58 CREDITS file. Thanks all !
  59
  60 -- LEGAL STUFF ---------------------------------------------------------------
  61
  62 LCDproc is Copyright (C) 1998-2006
  63         William Ferrell, Scott Scriven and many other contributors.
  64
  65 This program is free software; you can redistribute it and/or
  66 modify it under the terms of the GNU General Public License
  67 as published by the Free Software Foundation; either version 2
  68 of the License, or (at your option) any later version.
  69
  70 This program is distributed in the hope that it will be useful,
  71 but WITHOUT ANY WARRANTY; without even the implied warranty of
  72 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  73 GNU General Public License for more details.
  74
  75 The file COPYING contains the GNU General Public License.
  76 You should have received a copy of the GNU General Public License
  77 along with this program; if not, write to the Free Software
  78 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.