Readme.md 3.69 KB
Newer Older
1
OpenFlipper [![pipeline status](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/badges/master/pipeline.svg)](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/commits/master)
Jan Möbius's avatar
Jan Möbius committed
2
=======================
3

Jan Möbius's avatar
Jan Möbius committed
4 5 6
The documentation is on our website:
http://www.openflipper.org

7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
## Download Binaries

### Windows
* [VS2015 Qt-5.9.0 64-Bit](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/-/jobs/artifacts/master/browse/rel?job=Deploy:VS2015-Qt-5.9.0-x64)
* [VS2015 Qt-5.9.0 32-Bit](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/-/jobs/artifacts/master/browse/rel?job=Deploy:VS2015-Qt-5.9.0-x32)
* [VS2015 Qt-5.6.2 64-Bit](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/-/jobs/artifacts/master/browse/rel?job=Deploy:VS2015-Qt-5.6.2-x64)
* [VS2015 Qt-5.6.2 32-Bit](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/-/jobs/artifacts/master/browse/rel?job=Deploy:VS2015-Qt-5.6.2-x32)
* [VS2013 Qt-5.5.1 64-Bit](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/-/jobs/artifacts/master/browse/rel?job=Deploy:VS2015-Qt-5.5.1-x64)


### macOS 10.13
* [MacOS-10.13](https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free/-/jobs/artifacts/master/browse/rel?job=Deploy:Mac-Cpp11)



## Getting Source Code from git
23 24
Clone the repository with submodules:   
 git clone --recursive https://www.graphics.rwth-aachen.de:9000/OpenFlipper-Free/OpenFlipper-Free.git
Jan Möbius's avatar
Jan Möbius committed
25
 
26
## Required libs: 
Jan Möbius's avatar
Jan Möbius committed
27
Qt ( >= 5.5 )   http://www.qtsoftware.com/downloads  
28 29 30 31
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/  
Jan Möbius's avatar
Jan Möbius committed
32

33
## Compiling OpenFlipper:
34
A detailed compilation manual is available [here](http://openflipper.org/Documentation/latest/a00099.html).
Jan Möbius's avatar
Jan Möbius committed
35 36 37 38

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

Jan Möbius's avatar
Jan Möbius committed
39
- 04/21/2017: Moved all toplevel plugins to separate repositories.
Jan Möbius's avatar
Jan Möbius committed
40
- 02/28/2017: Removed SimpleOpt Command Line parser and switched to Qt parser
41
    - 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
42
- 12/28/2016: Moved ObjectTypes into separate Libraries
Jan Möbius's avatar
Jan Möbius committed
43 44 45 46 47 48
    - 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
49
- 12/12/2016: Moved MeshTools into libs_required (Will be moved to Mesh Datatype when the type linking is changed)
Jan Möbius's avatar
Jan Möbius committed
50
- 12/12/2016: Redistributables for Visual Studio removed (Now in library Management repository)
Jan Möbius's avatar
Jan Möbius committed
51
- 12/12/2016: Moved tests directory into OpenFlipper subdir
Jan Möbius's avatar
Jan Möbius committed
52
- 12/09/2016: Moved Math_Tools to OpenFlipper/libs_required/Math_Tools
53
- 12/09/2016: Moved OpenMesh directory into OpenFlipper subdirectory OpenFlipper/libs_required/OpenMesh
Jan Möbius's avatar
Jan Möbius committed
54
    - 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
55
- 12/09/2016: Moved ACG directory into OpenFlipper subdirectory OpenFlipper/libs_required/ACG
Jan Möbius's avatar
Jan Möbius committed
56 57
- 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)