Readme.md 2.46 KB
Newer Older
1 2 3 4 5 6
OpenFlipper README.TXT
=======================
The documentation is on our website:
http://www.openflipper.org

# Getting Source Code from git
7 8
Clone the repository with submodules:   
 git clone --recursive https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free.git
9
 
Jan Möbius's avatar
Jan Möbius committed
10
# Required libs: 
Jan Möbius's avatar
Jan Möbius committed
11
Qt ( >= 5.5 )   http://www.qtsoftware.com/downloads  
12 13 14 15
OpenGL          http://www.opengl.org  
GLUT            http://www.opengl.org/resources/libraries/glut  
GLEW            http://glew.sourceforge.net  
qwt ( >=6.0 )   optional http://qwt.sourceforge.net/  
16

Jan Möbius's avatar
Jan Möbius committed
17
# Compiling OpenFlipper:
18
A detailed compilation manual is available [here](http://openflipper.org/Documentation/latest/a00099.html).
Jan Möbius's avatar
Jan Möbius committed
19 20 21 22

Latest NEWS
===========

Jan Möbius's avatar
Jan Möbius committed
23
- 04/21/2017: Moved all toplevel plugins to separate repositories.
Jan Möbius's avatar
Jan Möbius committed
24
- 02/28/2017: Removed SimpleOpt Command Line parser and switched to Qt parser
25
    - Breaking Change: Commandline parameter have to start with a dash, the slash is not recognized as parameter prefix anymore.
Jan Möbius's avatar
Jan Möbius committed
26
- 12/28/2016: Moved ObjectTypes into separate Libraries
Jan Möbius's avatar
Jan Möbius committed
27 28 29 30 31 32
    - Plugins have to specify their used types in the cmake file (TYPES / OPT_TYPES e.g. TYPES TRIANGLEMESH ), defines (e.g. ENABLE_TRIANGLEMESH_SUPPORT) are added automatically
    - Plugins will not be compiled if an ObjectType is missing (Excluding OPT_TYPES of course)
    - In an ObjectType you have to do the following replaces
        * sed -i s/GlobalDefines.hh/ObjectTypeDLLDefines.hh/g *.hh
        * sed -i s/DLLEXPORT/OBJECTTYPEDLLEXPORT/g *.hh
    - A cmake file has to be created in the ObjectType directory containing only include(type)
Jan Möbius's avatar
Jan Möbius committed
33
- 12/12/2016: Moved MeshTools into libs_required (Will be moved to Mesh Datatype when the type linking is changed)
34
- 12/12/2016: Redistributables for Visual Studio removed (Now in library Management repository)
Jan Möbius's avatar
Jan Möbius committed
35
- 12/12/2016: Moved tests directory into OpenFlipper subdir
Jan Möbius's avatar
Jan Möbius committed
36
- 12/09/2016: Moved Math_Tools to OpenFlipper/libs_required/Math_Tools
37
- 12/09/2016: Moved OpenMesh directory into OpenFlipper subdirectory OpenFlipper/libs_required/OpenMesh
Jan Möbius's avatar
Jan Möbius committed
38
    - You might have to delete your libs_required/OpenMesh directory manually if you get cmake errors regarding duplicate targets 
Jan Möbius's avatar
Jan Möbius committed
39
- 12/09/2016: Moved ACG directory into OpenFlipper subdirectory OpenFlipper/libs_required/ACG
Jan Möbius's avatar
Jan Möbius committed
40 41
- 12/08/2016: Moved CI directory into OpenFlipper subdirectory to remove toplevel dir count
- 12/08/2016: Moved the cmake directory contents into OpenFlipper/cmake (First steps to reduce number of toplevel dirs and get more modular than before)