11[ POV-Ray] ( http://www.povray.org/ ) - The Persistence of Vision Raytracer
22=======================================================================
33
4- This document is a WIP
5- --------------------------------------
6-
7- This document is still a work in progress. While the POV-Ray project itself
8- has existed for more than 20 years, this is the first time we have done a
9- release on github, so please bear with us - it's a little bare at the moment.
10-
11- Please also be aware that we are in the process of actually doing the 3.7
12- release right now, and this document may refer to things that have not happened
13- yet on the main website (e.g. the release of the binaries, updating of pages,
14- and so forth).
15-
16- Last edit: 2013-11-06
4+ [ ![ Semaphore Build Status] ( https://semaphoreci.com/api/v1/pov-ray/povray/branches/master/shields_badge.svg?label=Semaphore )] ( https://semaphoreci.com/pov-ray/povray " Semaphore: Ubuntu 14.04 LTE 64-bit with gcc 4.8 ")
5+ [ ![ AppVeyor Build status] ( https://img.shields.io/appveyor/ci/c-lipka/povray-exwy4.svg?label=appveyor )] ( https://ci.appveyor.com/project/c-lipka/povray-exwy4 " AppVeyor: Windows Server 2012 with Visual Studio 2015 ")
6+ [ ![ Travis CI Build Status] ( https://img.shields.io/travis/POV-Ray/povray.svg?label=travis%20ci )] ( https://travis-ci.org/POV-Ray/povray " Travis CI: Ubuntu 12.04 LTE 64-bit with gcc 4.6; OS X 10.11 with clang 4.2 ")
7+ [ ![ Coverity Code Analysis] ( https://scan.coverity.com/projects/269/badge.svg )] ( https://scan.coverity.com/projects/pov-ray " Coverity: Static Code Analysis ")
8+ [ ![ Maintenance Status] ( https://img.shields.io/maintenance/yes/2017.svg )] ( README.md " Last edited 2017-03-24 ")
179
1810License
1911--------------------------------------
@@ -37,35 +29,39 @@ Bug Reports
3729
3830It's generally a good idea to mention a bug in the forums prior to lodging a formal
3931report; this can save you some time if it's a non-bug or a solution is known. You
40- should also check our bug tracker at http://bugs.povray.org/ first to see if it's
41- been reported.
42-
43- If you're sure something is a bug then please do lodge a bugreport on the tracker.
44- While we are aware that github has its own tracker, please keep in mind that POV-Ray
45- is a long-established project (more than 20 years) and we prefer to use our own tracker.
46- We do not do our primary develoment on github (at least, not at this point). Our RCS
47- for the past 15 or so years has been Perforce. We will be pulling patches from here
48- into perforce, and pushing changes out to github from time to time. At some point we
49- will switch to using Perforce's Git Fusion product and this process will become
50- automatic.
32+ should also first check the [ known issues] ( https://github.com/POV-Ray/povray/issues )
33+ to see if it has been reported already.
34+
35+ If you're sure something is a bug then please do lodge a bug report on the GitHub issues tracker.
5136
5237Official Binaries
5338--------------------------------------
5439
55- At this point in time, the only platform for which the project distributes pre-
56- built 'official' (i.e. supported) binaries is Microsoft Windows. These may be
40+ At this point in time, the only platform for which the project distributes pre-built
41+ 'official' (i.e. supported) binaries is Microsoft Windows. These may be
5742obtained via http://www.povray.org/download/ . We do intend to provide Mac OS X
5843binaries shortly, but these will be console-mode only (based on the unix build).
5944
45+ Official Windows binaries of selected development versions are made availabe at
46+ https://github.com/POV-Ray/povray/projects on a semi-irregular basis.
47+
6048Building POV-Ray
6149--------------------------------------
6250
63- At this point in time we recommend building from the 3.7-stable branch. POV-Ray
64- should compile on any POSIX-compliant system with the required tools (please see
51+ At this point in time we generally recommend building from the latest version of the
52+ [ 3.7-stable branch] ( https://github.com/POV-Ray/povray/tree/3.7-stable ) . Alternatively,
53+ you may want to opt for a recent [ tagged version] ( https://github.com/POV-Ray/povray/tags )
54+ to test-drive features that have been added since the last stable release.
55+
56+ _ Please do not build directly from the master branch_ (or any other non-stable branch
57+ for that matter), as versions from that branch may report ambiguous version numbers,
58+ making it difficult to obtain version-specific support or report bugs in a useful manner.
59+
60+ POV-Ray 3.7.0 should compile on any POSIX-compliant system with the required tools (please see
6561[ unix/README.md] ( unix/README.md ) for build instructions),
6662on Microsoft Windows systems that have Visual Studio 2010 or later installed (targeting
67- XP or later, both 32 and 64-bit - be sure to see README.HTML in the windows source dir ,
68- otherwise your build * will not work * ), and also on Mac systems (console mode only, using
63+ XP or later, both 32 and 64-bit - be sure to see [ windows/ README.md ] ( windows/README.md ) ,
64+ otherwise your build _ will not work _ ), and also on Mac systems (console mode only, using
6965an appropriately-modified version of the unix build - not currently provided by us).
7066
7167If you are using an operating system with a package or ports system such as
@@ -94,7 +90,7 @@ Putting it another way: we consider getting a cross-platform IDE a high priority
9490POV-Ray does not currently have its own 3d modelling application (at least, not one
9591in a usable state). We do own the rights to the Moray modeller, which was formerly
9692commercial, but it needs a little work to get it working with v3.7. It is also
97- windows only (due to its use of MFC). Nevertheless we will be adding the source
93+ Windows only (due to its use of MFC). Nevertheless we will be adding the source
9894to the repository at a future date.
9995
10096Authors of open-source modellers with a compatible licence wishing to directly
@@ -108,9 +104,9 @@ of POV-Ray come with documentation. For the Unix build, this is in the form of a
108104manpage giving basic usage, and full HTML-based documentation. For the Windows
109105version, there is a HtmlHelp (.CHM) file provided.
110106
111- The official location for the online documentation is http://www.povray.org/documentation/ ,
112- however please be aware that at the time of writing this still has the version 3.6 docs.
113- This will be updated shortly .
107+ The official location for the online documentation is http://www.povray.org/documentation/ .
108+ Further information, as well as online documentation for the current development
109+ version, can be found at http://wiki.povray.org .
114110
115111Contacting Us
116112--------------------------------------
0 commit comments