|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | 03-May-2022 | - |
| doc/html/ | H | 09-Aug-2021 | - | 753 | 637 |
| icons/ | H | 03-May-2022 | - | | |
| include/ | H | 03-May-2022 | - | 19,079 | 17,192 |
| ini/ | H | 09-Aug-2021 | - | 508 | 454 |
| platform/ | H | 09-Aug-2021 | - | 3,891 | 2,275 |
| scenes/ | H | 09-Aug-2021 | - | 91,685 | 83,006 |
| scripts/ | H | 09-Aug-2021 | - | 815 | 498 |
| source/ | H | 09-Aug-2021 | - | 200,191 | 114,233 |
| unix/ | H | 03-May-2022 | - | 16,120 | 12,572 |
| vfe/ | H | 09-Aug-2021 | - | 8,733 | 5,487 |
| AUTHORS | H A D | 09-Aug-2021 | 1.2 KiB | 27 | 20 |
| COPYING | H A D | 09-Aug-2021 | 944 | 21 | 15 |
| ChangeLog | H A D | 09-Aug-2021 | 37 | 2 | 1 |
| INSTALL | H A D | 09-Aug-2021 | 22.1 KiB | 512 | 388 |
| LICENSE | H A D | 09-Aug-2021 | 33.7 KiB | 662 | 544 |
| Makefile.in | H A D | 09-Aug-2021 | 40.6 KiB | 1,177 | 1,017 |
| NEWS | H A D | 09-Aug-2021 | 290 | 7 | 5 |
| README | H A D | 09-Aug-2021 | 2.4 KiB | 55 | 41 |
| README.md | H A D | 09-Aug-2021 | 6.2 KiB | 127 | 95 |
| VERSION | H A D | 09-Aug-2021 | 13 | 2 | 1 |
| aclocal.m4 | H A D | 09-Aug-2021 | 44.5 KiB | 1,232 | 1,120 |
| configure | H A D | 09-Aug-2021 | 583.7 KiB | 19,345 | 14,905 |
| kde_install.sh | H A D | 09-Aug-2021 | 26.1 KiB | 854 | 643 |
| povray.1 | H A D | 09-Aug-2021 | 15.2 KiB | 367 | 343 |
| povray.conf | H A D | 09-Aug-2021 | 4.3 KiB | 98 | 88 |
| povray.ini.in | H A D | 09-Aug-2021 | 2.4 KiB | 74 | 69 |
README
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
README.md
1[POV-Ray](http://www.povray.org/) - The Persistence of Vision Raytracer
2=======================================================================
3
4[](https://github.com/POV-Ray/povray/actions/workflows/test_build_quick.yml)
5[](https://github.com/POV-Ray/povray/actions/workflows/codeql-analysis.yml)
6[](README.md "Last edited 2021-06-26")
7
8- [License](#license)
9- [Forums](#forums)
10- [Bug Reports](#bug-reports)
11- [Official Binaries](#official-binaries)
12- [Building POV-Ray](#building-pov-ray)
13- [IDE Versions](#ide-versions)
14- [3D Modeller](#3d-modeller)
15- [Documentation](#documentation)
16- [Contacting Us](#contacting-us)
17
18License
19--------------------------------------
20
21As of version v3.7, the source for POV-Ray is licensed under the AGPL3. The documentation is under the
22Creative Commons Attribution-Noncommercial-ShareAlike 2.5 license, and support files such
23as SDL includes, macros, sample scenes and so forth are under the Creative Commons Attribution-ShareAlike
243.0 Unported License (see each file header for the specific one).
25
26Forums
27--------------------------------------
28
29Discussion regarding POV-Ray is traditionally done via our forums at http://news.povray.org/.
30These are also available via NNTP at news://news.povray.org/ for those preferring that.
31
32Please note that the POV-Ray developers do not monitor all forums regularly. The ones we
33tend to check most frequently are povray.general, povray.windows and povray.unix.
34
35Bug Reports
36--------------------------------------
37
38It's generally a good idea to mention a bug in the forums prior to lodging a formal
39report; this can save you some time if it's a non-bug or a solution is known. You
40should also first check the [known issues](https://github.com/POV-Ray/povray/issues)
41to see if it has been reported already.
42
43If you're sure something is a bug then please do lodge a bug report on the GitHub issues tracker.
44
45Official Binaries
46--------------------------------------
47
48At this point in time, the only platform for which the project distributes pre-built
49'official' (i.e. supported) binaries is Microsoft Windows. These may be
50obtained via http://www.povray.org/download/. We do intend to provide Mac OS X
51binaries shortly, but these will be console-mode only (based on the unix build).
52
53Official Windows binaries of selected development versions are made availabe at
54https://github.com/POV-Ray/povray/releases on a semi-irregular basis.
55
56Building POV-Ray
57--------------------------------------
58
59At this point in time we generally recommend building from the latest version of the
60[`latest-stable` branch](https://github.com/POV-Ray/povray/tree/latest-stable). Alternatively,
61you may want to opt for a recent [tagged version](https://github.com/POV-Ray/povray/tags)
62to test-drive features that have been added since the latest stable release.
63
64_Please do not build directly from the master branch_ (or any other non-stable branch
65for that matter), as versions from that branch may report ambiguous version numbers,
66making it difficult to obtain version-specific support or report bugs in a useful manner.
67
68POV-Ray should compile on any POSIX-compliant system with the required tools (please see
69[unix/README.md](unix/README.md) for build instructions),
70on Microsoft Windows systems that have Visual Studio 2015 Update 1 or later installed (targeting
71XP or later, both 32 and 64-bit - be sure to see [windows/README.md](windows/README.md),
72otherwise your build _will not work_), and also on Mac systems (console mode only, using
73an appropriately-modified version of the unix build - not currently provided by us).
74
75If you are using an operating system with a package or ports system such as
76Ubuntu or FreeBSD, you may like to check whether or not POV-Ray is available
77via that route.
78
79IDE versions
80--------------------------------------
81
82Currently the only version of POV-Ray with an IDE as such is the Windows build.
83We do want to change that, though. With the release of POV-Ray v3.7 we have added
84a clear split between the backend (renderer) and frontend (UI or console), along
85with a C++ layer which abstracts this into a fairly easily-understood set of
86classes (VFE, aka 'Virtual Front End').
87
88We will offer support to those wishing to use this interface layer to integrate
89POV-Ray into an open-source cross-platform IDE. We would also be interested in
90hearing suggestions as to what we could base such an IDE on, should we go ahead
91to integrate it ourselves.
92
93Putting it another way: we consider getting a cross-platform IDE a high priority.
94
953D Modeller
96-------------------------------------
97
98POV-Ray does not currently have its own 3d modelling application (at least, not one
99in a usable state). We do own the rights to the Moray modeller, which was formerly
100commercial, but it needs a little work to get it working with v3.7 or later. It is also
101Windows only (due to its use of MFC). Nevertheless we will be adding the source
102to the repository at a future date.
103
104Authors of open-source modellers with a compatible licence wishing to directly
105integrate POV-Ray are welcome to contact us for support in doing so.
106
107Documentation
108--------------------------------------
109
110When built and installed via the means provided in the source tree, all versions
111of POV-Ray come with documentation. For the Unix build, this is in the form of a
112manpage giving basic usage, and full HTML-based documentation. For the Windows
113version, there is a HtmlHelp (.CHM) file provided.
114
115The official location for the online documentation is http://www.povray.org/documentation/.
116Further information, as well as online documentation for the current development
117version, can be found at http://wiki.povray.org.
118
119Contacting Us
120--------------------------------------
121
122We prefer that you contact us via the forums mentioned at the head of this document.
123If the matter is one that requires direct email contact (and this generally will NOT
124include tech support requests, though exceptions are made for package maintainers)
125you may use the address listed at the bottom of http://www.povray.org/povlegal.html.
126
127
){kind=link}
){kind=link}
){kind=link}