1===============================================================================
2POV-Ray v3.8 for UNIX/Linux - README file
3
4For the generic source distribution for UNIX/Linux
5===============================================================================
6
7+----------------------------------------------------------------------------+
8| NOTE: If this file does not reside in the root directory of your POV-Ray   |
9| source package, you have received a platform-neutral package. In that case |
10| make sure to run the following command before you proceed:                 |
11|                                                                            |
12|   cd unix/ ; ./prebuild.sh ; cd ../                                        |
13+----------------------------------------------------------------------------+
14
15This is the README file for the generic UNIX/Linux distribution of the
16POV-Ray v3.8 source code.
17
18
19===================
20Source code package
21===================
22
23This package contains the complete source code of POV-Ray for UNIX
24as well as its accompanying HTML documentation and supporting files.
25The package substructure is organized as follows:
26
27  source/     Platform-independent source code (POV-Ray core code).
28  unix/       UNIX-specific source code, including X Window and SVGA support.
29  config/     UNIX-specific configuration and installation scripts.
30  doc/        UNIX-specific and generic HTML documentation, POV-Ray license.
31  icons/      UNIX-specific color icons for the KDE window manager.
32  scripts/    UNIX-specific render scripts (portfolio, stills, animations).
33  include/    Standard POV-Ray include files.
34  ini/        Standard POV-Ray INI files.
35  scenes/     Standard POV-Ray sample scene files.
36
37
38========================
39Compiling and installing
40========================
41
42Basic and detailed instructions to compile and install the generic POV-Ray
43source code on UNIX-based systems are given in the INSTALL file.
44
45In a nutshell: the package installation is based on a configure script
46which detects your environment automatically and adapts the compilation
47and installation process accordingly.  Simply run:
48
49% ./configure COMPILED_BY="your name <email@address>"  # configure the package
50% make                                                 # build the program
51% su                                                   # log as root
52$ make install                                         # install program + data
53
54See the INSTALL file for more detailed information.
55