erebus

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