Help/README

   1                         ROX-Lib2
   2                         Shared code for ROX applications
   3                         by Thomas Leonard
   4                         http://rox.sourceforge.net
   5
   6 Quick start
   7 ~~~~~~~~~~~
   8 Move the ROX-Lib2 directory inside ~/lib, /usr/local/lib or /usr/lib.
   9
  10 Programs which require ROX-Lib2 should now be able to find it. If you
  11 want it somewhere else, set the LIBDIRPATH environment variable to a
  12 colon separated list of directories to search for ROX-Lib2 and other
  13 libraries.
  14
  15 Zero Install users don't have to do anything. Except for some very old
  16 ones, programs will get it directly through Zero Install.
  17
  18
  19 Introduction
  20 ~~~~~~~~~~~~
  21 There is quite a lot of code which is needed by many ROX applications -- for
  22 example: save boxes, menus and options.
  23
  24 Keeping all this code in one place makes these programs smaller. It also
  25 makes programs which use it more consistant.
  26
  27 Programs which use ROX-Lib2 need to be able to find it, so you should put it
  28 inside one of the standard library directories. If you don't have root
  29 access, create a directory called 'lib' inside your home directory and move
  30 ROX-Lib2 in there.
  31
  32 If you do have root access, move ROX-Lib2 into /usr/local/lib.
  33
  34
  35 Developers
  36 ~~~~~~~~~~
  37 For people wishing to write programs using this library, look in the
  38 'ROX-Lib2/Help/python' directory.
  39
  40 There is also some on-line documentation here:
  41
  42         http://rox.sourceforge.net/rox_lib.html
  43
  44
  45 Translators
  46 ~~~~~~~~~~~
  47 If you want to translate ROX-Lib2 into your native language, follow
  48 these steps (replace 'fr' with your language):
  49
  50 $ cd ROX-Lib2/Messages
  51 $ ./update-po
  52 $ cp ../python/rox/messages.pot fr.po
  53 [ edit fr.po ]
  54 $ ./dist
  55
  56 Updating an existing translation is the same, except you skip the 'cp' step.
  57
  58
  59 Conditions
  60 ~~~~~~~~~~
  61 Copyright (C) 2002  Thomas Leonard
  62
  63 This library is free software; you can redistribute it and/or
  64 modify it under the terms of the GNU Lesser General Public
  65 License as published by the Free Software Foundation; either
  66 version 2.1 of the License, or (at your option) any later version.
  67
  68 This library is distributed in the hope that it will be useful,
  69 but WITHOUT ANY WARRANTY; without even the implied warranty of
  70 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  71 Lesser General Public License for more details.
  72
  73 You should have received a copy of the GNU Lesser General Public
  74 License along with this library; if not, write to the Free Software
  75 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
  76
  77
  78 Please report any bugs to me, <tal197@users.sourceforge.net>.