erebus

diff README.md @ 35:4901cf062c70

added COPYING and augmented the README file
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 09 Jun 2014 07:24:22 +0300
parents 6204e4d3f445
children 6eab83024d28
line diff
     1.1 --- a/README.md	Sun Jun 08 08:12:05 2014 +0300
     1.2 +++ b/README.md	Mon Jun 09 07:24:22 2014 +0300
     1.3 @@ -3,8 +3,36 @@
     1.4  Erebus is a free photorealistic renderer, written in C++11.
     1.5  Copyright (C) 2014  John Tsiombikas <nuclear@member.fsf.org>
     1.6  
     1.7 -This program is released as free software, under the terms of the GNU General
     1.8 +This program is free software, released under the terms of the GNU General
     1.9  Public License v3, or at your option, any later version published by the Free
    1.10 -Software Foundation.
    1.11 +Software Foundation. See COPYING for more details.
    1.12  
    1.13 -**This program is in a very early stage of development. Don't bother trying it.**
    1.14 +Web site: http://nuclear.mutantstargoat.com/sw/erebus
    1.15 +Canonical repo (hg): http://nuclear.mutantstargoat.com/hg/erebus
    1.16 +GitHub (mirror): https://github.com/jtsiomb/erebus
    1.17 +
    1.18 +**Erebus is still in a very early stage of development. Don't bother trying it yet.**
    1.19 +
    1.20 +## Build instructions
    1.21 +
    1.22 +To build erebus you first need to install the following libraries:
    1.23 +* libvmath: http://code.google.com/p/libvmath or http://github.com/jtsiomb/libvmath
    1.24 +* libimago2: http://code.google.com/p/libimago or http://github.com/jtsiomb/libimago
    1.25 +* libdrawtext: http://nuclear.mutantstargoat.com/sw/libdrawtext or http://github.com/jtsiomb/libdrawtext
    1.26 +* GLUT: any implementation will do, try http://freeglut.sourceforge.net
    1.27 +
    1.28 +### UNIX
    1.29 +To build erebus on UNIX just type make in the root project directory. You need a
    1.30 +C++ compiler with C++11 support; recent versions of GCC and Clang should do the
    1.31 +trick.
    1.32 +
    1.33 +### Windows
    1.34 +On Windows you have the choice to build using either ms visual studio or mingw.
    1.35 +For mingw, just type make as described by the UNIX instructions above, and it
    1.36 +should hopefully work.
    1.37 +
    1.38 +If you choose to build using visual studio, you'll need at least VS2013 for the
    1.39 +required level of C++11 support. Open the included erebus.sln solution file, and
    1.40 +hit build (ctrl+b). Make sure you've set up visual studio's header/library
    1.41 +search paths first to allow visual studio to find the dependencies outlined
    1.42 +above.