home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 April / Chip_2004-04_cd1.bin / software / tux / tuxpaint.exe / docs / INSTALL.txt < prev    next >
Text File  |  2003-12-24  |  11KB  |  300 lines
  1. INSTALL.txt for Tux Paint
  2.  
  3. Tux Paint - A simple drawing program for children.
  4.  
  5. Copyright 2002 by Bill Kendrick
  6. bill@newbreedsoftware.com
  7. http://www.newbreedsoftware.com/tuxpaint/
  8.  
  9. June 27, 2002 - November 5, 2002
  10.  
  11.  
  12. Requirements:
  13. -------------
  14.   Windows Users:
  15.   --------------
  16.     The Windows version of Tux Paint comes pre-packaged with the
  17.     necessary pre-compiled libraries (in ".DLL" form), so no extra
  18.     downloading is needed.
  19.     
  20.   libSDL
  21.   ------
  22.     Tux Paint requires the Simple DirectMedia Layer Library (libSDL),
  23.     an Open Source multimedia programming library available under the
  24.     GNU Lesser General Public License (LGPL).
  25.  
  26.     Along with libSDL, Tux Paint depends on a number of other SDL 'helper'
  27.     libraries:  SDL_Image (for graphics files), SDL_TTF (for True Type Font
  28.     support) and, optionally, SDL_Mixer (for sound effects).
  29.  
  30.     Linux/Unix Users:
  31.     -----------------
  32.       The SDL libraries are available as source-code, or as RPM or Debian
  33.       packages for various distributions of Linux.  They can be downloaded
  34.       from:
  35.  
  36.         libSDL:      http://www.libsdl.org/
  37.         SDL_Image:   http://www.libsdl.org/projects/SDL_image/
  38.         SDL_TTF:     http://www.libsdl.org/projects/SDL_ttf/
  39.         SDL_Mixer:   http://www.libsdl.org/projects/SDL_mixer/   [OPTIONAL]
  40.  
  41.       They are also typically available along with your Linux distribution
  42.       (e.g. on an installation CD, or available via package maintainance
  43.       software like Debian's "apt-get").
  44.  
  45.       NOTE: When installing from packages, be sure to ALSO install the
  46.       "-devel" versions of the packages.  (For example, install both
  47.       "SDL-1.2.4.rpm" AND "SDL-1.2.4-devel.rpm")
  48.  
  49.   Other Libraries:
  50.   ----------------
  51.     Tux Paint also takes advantage of a number of other
  52.     free, LGPL'd libraries.  Under Linux, just like SDL, they should
  53.     either already be installed, or are readily available for installation
  54.     as part of your Linux distribution.
  55.     
  56.     libPNG
  57.     ------
  58.       Tux Paint uses PNG (Portable Network Graphics) format for its
  59.       data files.  SDL_image will require libPNG be installed.
  60.  
  61.         http://www.libpng.org/pub/png/libpng.html
  62.  
  63.     FreeType2
  64.     ---------
  65.       Tux Paint uses TTF (True Type Font) fonts for drawing text.
  66.       SDL_ttf will require the FreeType2 library.
  67.  
  68.         http://www.freetype.org/
  69.  
  70.     gettext
  71.     -------
  72.       Tux Paint uses your system's locale settings along with the
  73.       "gettext" library to support various languages (e.g., Spanish).
  74.       You'll need the gettext library installed.
  75.  
  76.         http://www.gnu.org/software/gettext/
  77.  
  78.     NetPBM Tools  [OPTIONAL]
  79.     ------------------------
  80.       Under Linux and Unix, the NetPBM tools are what are currently
  81.       used for printing.  (A PNG is generated by TuxPaint, and converted
  82.       into a PostScript using the 'pngtopnm' and 'pnmtops' NetPBM command-line
  83.       tools.)
  84.  
  85.         http://netpbm.sourceforge.net/
  86.     
  87.  
  88. Compiling and Installation:
  89. ---------------------------
  90.   Tux Paint is released under the GNU General Public License (GPL)
  91.   (see "COPYING.txt" for details), and therefore the 'source code' to
  92.   the program is included.
  93.  
  94.   Windows Users:
  95.   --------------
  96.     Compiling:
  97.     ----------
  98.       Tux Paint comes pre-compiled for Windows, so no compilation is
  99.       necessary.  [Eventually, information on rebuilding for Windows
  100.       will be placed here.  In the meantime, you're on your own.  Sorry!]
  101.  
  102.     Installer:
  103.     ----------
  104.       Double-click the Tux Paint installer executable (.EXE file) and
  105.       follow the instructions.
  106.  
  107.       First, you will be asked to agree to the license.
  108.       (It is the GNU General Public License (GPL), which is also
  109.       available as "COPYING.txt".)
  110.  
  111.       You will then be asked whether you want to install shortcuts
  112.       to Tux Paint in your Windows Start Menu and on your Windows Desktop.
  113.       (Both options are set by default.)
  114.  
  115.       Then you will be asked where you wish to install Tux Paint.
  116.       The default should be suitable, as long as there is space available.
  117.       Otherwise, pick a different location.
  118.  
  119.       At this point, you can click 'Install' to install Tux Paint!
  120.  
  121.     Changing the Settings Using the Shortcut:
  122.     -----------------------------------------
  123.       To change program settings, right-click on the TuxPaint shortcut
  124.       and select 'Properties' (at the bottom).
  125.        
  126.       Make sure the 'Shortcut' tab is selected in the window that
  127.       appears, and examine the 'Target:' field.  You should see
  128.       something like this :
  129.  
  130.         "C:\Program Files\TuxPaint\TuxPaint.exe"
  131.  
  132.       You can now add command-line options which will be enabled when
  133.       you double-click the icon.
  134.        
  135.       For example, to make the game run in fullscreen mode,
  136.       with simple shapes (no rotation option) and in French,
  137.       add the options (after 'TuxPaint.exe'), like so:
  138.  
  139.         "C:\Program Files\TuxPaint\TuxPaint.exe" -f -s --lang french
  140.  
  141.       (See "README.txt" for a full list of available command-line options.)
  142.        
  143.       If you make a mistake or it all disappears use Ctrl-Z to undo or
  144.       just hit the [ESC] key and the box will close with no changes made
  145.       (unless you pushed the "Apply" button!).
  146.        
  147.       When you have finished, click "OK."
  148.  
  149.     If Something Goes Wrong
  150.     -----------------------
  151.       If, when you double-click on the shortcut to run the game,
  152.       nothing happens, it is probably because some of these command-line
  153.       options are wrong. Open an Explorer like before, and look for a file
  154.       called 'stderr.txt' in the TuxPaint folder.
  155.     
  156.       It will contain a description of what was wrong. Usually it will
  157.       just be due to incorrect character-case (capital 'Z' instead
  158.       of lowercase 'z') or a missing (or extra) '-' (dash).
  159.   
  160.   
  161.   Linux/Unix Users:
  162.   -----------------
  163.     Compiling:
  164.     ----------
  165.       Note: Currently, Tux Paint does not use autoconf/automake, so there
  166.       is no "./configure" script to run.  (Sorry!)  Compiling should be
  167.       straight-forward though, assuming everything Tux Paint needs is installed.
  168.  
  169.       To compile the program from source, simply run the following command
  170.       from a shell prompt (e.g., "$"):
  171.  
  172.         $ make
  173.  
  174.     Disabling Sound at Compile-time:
  175.     --------------------------------
  176.       Alternatively, if you don't have a sound card, or would prefer to build
  177.       the program with no sound support (therefore, SDL_mixer not having to be
  178.       installed), you can run "make" with "nosound" as the 'target', instead:
  179.  
  180.         $ make nosound
  181.  
  182.  
  183.     If you get errors:
  184.     ------------------
  185.       If you receive any errors during compile-time, make sure you have
  186.       the appropriate libraries installed (see above).  If using packaged
  187.       versions of the libraries (e.g., RPMs under RedHat or DEBs under Debian),
  188.       be sure to get the corresponding "-dev" or "-devel" packages as well,
  189.       otherwise you won't be able to compile Tux Paint (and other programs)
  190.       from source!
  191.  
  192.  
  193.     Installing:
  194.     -----------
  195.       Assuming no fatal errors occured, you can now install the program
  196.       so that it can be run by users on the system.  By default, this must
  197.       be done by the "root" user ('superuser').  Switch to "root" by
  198.       typing the command:
  199.  
  200.         $ su
  201.  
  202.       Enter "root"'s password at the prompt.  You should now be "root"
  203.       (with a prompt like "#").  To install the program and its
  204.       data files, type:
  205.  
  206.         # make install
  207.  
  208.       Finally, you can switch back to your regular user by exiting
  209.       superuser mode:
  210.  
  211.         # exit
  212.  
  213.  
  214.       NOTE: By default, "tuxpaint", the executable program, is
  215.       placed in "/usr/local/bin/".  The data files (images, sounds, etc.)
  216.       are placed in "/usr/local/share/tuxpaint/".
  217.  
  218.  
  219.       Changing Where Things Go
  220.       ------------------------
  221.         You can change where things will go by using the 'prefix'
  222.         variables in Makefile.  "PREFIX" is the basis of where all other
  223.         files go, and is, by default, set to "/usr/local".
  224.  
  225.         Other variables are:
  226.           BIN_PREFIX
  227.         Where the "tuxpaint" binary will be installed.
  228.         (Set to "$(PREFIX)/bin" by default - e.g., "/usr/local/bin")
  229.       
  230.       DATA_PREFIX
  231.         Where the data files (sound, graphics, brushes, stamps, fonts)
  232.          will go, and where Tux Paint will look for them when it's run.
  233.         (Set to "$(PREFIX)/share/tuxpaint")
  234.     
  235.       DOC_PREFIX
  236.         Where the documentation text files (the "docs" directory) will go.
  237.         (Set to "$(PREFIX)/share/doc/tuxpaint")
  238.     
  239.       MAN_PREFIX
  240.         Where the manual page for Tux Paint will go.
  241.         (Set to "$(PREFIX)/share/man")
  242.     
  243.       ICON_PREFIX                      $(PREFIX)/share/pixmaps
  244.       X11_ICON_PREFIX                  $(PREFIX)/X11R6/include/X11/pixmaps
  245.       GNOME_PREFIX                     $(PREFIX)/share/gnome/apps/Graphics
  246.       KDE_PREFIX                       $(PREFIX)/share/applnk/Graphics
  247.         Where the icons and launchers (for GNOME and KDE) will go.
  248.     
  249.       LOCALE_PREFIX
  250.         Where the translation files for Tux Paint will go, and where
  251.         Tux Paint will look for them.
  252.         (Set to "$(PREFIX)/share/locale/")
  253.         (Final location of a translation file will be
  254.         under the locale's directory (e.g., "es" for Spanish),
  255.         within the "LC_MESSAGES" subdirectory.)
  256.     
  257.     
  258. Uninstalling Tux Paint:
  259. -----------------------
  260.   Windows
  261.   -------
  262.     Using the Uninstaller
  263.     ---------------------
  264.       If you installed the Start Menu shortcuts (the default), then go to the 
  265.       TuxPaint folder and select "Uninstall". A box will be displayed that will 
  266.       confirm that you are about to uninstall Tux Paint and, if you are certain
  267.       that you want to permanently remove Tux Paint, click on the 'Uninstall'
  268.       button. 
  269.  
  270.       When it has finished, click on the close button.
  271.  
  272.       It is also possible to use the entry "TuxPaint (remove only)" in the
  273.       Control Panel Add/Remove programs section.
  274.  
  275.       NOTE: because the pictures that are created are saved inside the Tux Paint 
  276.       folder, this folder and the 'userdata' folder inside it are NOT removed.
  277.  
  278.  
  279.   Linux
  280.   -----
  281.     Within the Tux Paint source directory (where you compiled Tux Paint),
  282.     you can use a 'Makefile' target to uninstall Tux Paint.
  283.     By default, this must be done by the "root" user ('superuser').
  284.     (See the installation instructions above for further information.)
  285.  
  286.     Switch to "root" by typing the command:
  287.  
  288.       $ su
  289.  
  290.     Enter "root"'s password at the prompt.  You should now be "root"
  291.     (with a prompt like "#").  To uninstall the program and its data files
  292.     (the default rubber-stamp images, if any, will also be removed), type:
  293.  
  294.       # make uninstall
  295.  
  296.     Finally, you can switch back to your regular user by exiting
  297.     superuser mode:
  298.  
  299.       # exit
  300.