erebus

view README.md @ 36:6eab83024d28

small markdown fix in readme
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 09 Jun 2014 07:28:03 +0300
parents 4901cf062c70
children
line source
1 #![Erebus](http://nuclear.mutantstargoat.com/sw/erebus/img/erebus_banner_med.jpg)
3 Erebus is a free photorealistic renderer, written in C++11.
4 Copyright (C) 2014 John Tsiombikas <nuclear@member.fsf.org>
6 This program is free software, released under the terms of the GNU General
7 Public License v3, or at your option, any later version published by the Free
8 Software Foundation. See COPYING for more details.
10 - Web site: http://nuclear.mutantstargoat.com/sw/erebus
11 - Canonical repo (hg): http://nuclear.mutantstargoat.com/hg/erebus
12 - GitHub (mirror): https://github.com/jtsiomb/erebus
14 **Erebus is still in a very early stage of development. Don't bother trying it yet.**
16 ## Build instructions
18 To build erebus you first need to install the following libraries:
19 - libvmath: http://code.google.com/p/libvmath or http://github.com/jtsiomb/libvmath
20 - libimago2: http://code.google.com/p/libimago or http://github.com/jtsiomb/libimago
21 - libdrawtext: http://nuclear.mutantstargoat.com/sw/libdrawtext or http://github.com/jtsiomb/libdrawtext
22 - GLUT: any implementation will do, try http://freeglut.sourceforge.net
24 ### UNIX
25 To build erebus on UNIX just type make in the root project directory. You need a
26 C++ compiler with C++11 support; recent versions of GCC and Clang should do the
27 trick.
29 ### Windows
30 On Windows you have the choice to build using either ms visual studio or mingw.
31 For mingw, just type make as described by the UNIX instructions above, and it
32 should hopefully work.
34 If you choose to build using visual studio, you'll need at least VS2013 for the
35 required level of C++11 support. Open the included erebus.sln solution file, and
36 hit build (ctrl+b). Make sure you've set up visual studio's header/library
37 search paths first to allow visual studio to find the dependencies outlined
38 above.