Merge branch 'release-0.2'

Author: HuguesDelorme

.gitignore

@@ -0,0 +1,5 @@
+build-*
+*.user
+*.user.*
+installer/setupvars.iss
+installer/Output

README.md

@@ -1,23 +1,42 @@
 # Mayo
 Mayo is a basic 3D viewer inspired by FreeCad.  
-Its primary goal is to visualize CAD files imported/exported
-with the [gmio](https://github.com/fougue/gmio) library.  
 
 Current features are :
 * Multi-documents support, user can open many parts in the session
 * Support of IGES/STEP/BRep formats for import/export operations
-* Support of STL format with either [gmio](https://github.com/fougue/gmio) or OpenCascade(see the speed performance of gmio!)
+* Support of STEP/IGES assemblies (colors and tree structure)
+* Support of STL format with either OpenCascade or [gmio](https://github.com/fougue/gmio) (optional)
+* Perspective/orthographic 3D view projection
+* 3D clip planes with configurable capping
 * Save image(snapshot) of the current 3D view
+* Editable name of STEP/IGES entities
 * Editable 3D properties of the imported items, eg. material, color, display mode, ...
+* Area and volume properties for meshes and shapes
+
+3D viewer operations :
+* Rotate : mouse left + move
+* Pan : mouse right + move
+* Zoom : mouse wheel(scroll)
+* Window zoom : mouse wheel + move
+* Instant zoom : space bar
 
 # Build instructions
-Mayo requires Qt5 and OpenCascade-7.0.0.  
+Mayo requires Qt5 and OpenCascade-7.2.0.  
 Although only tested with VC++/Windows it should build fine on Linux and MacOS.  
+It uses the `CSF_OCCTIncludePath` and `CSF_OCCTLibPath` environment variables to locate
+OpenCascade include and lib paths. On Windows these two variables are set by the `env.bat`
+script which can be found within OpenCascade's base folder. You should run this batch before
+building mayo :  
 `cd .../mayo`  
-`qmake "GMIO_ROOT=path_to_gmio" "CASCADE_ROOT=path_to_opencascade"`  
-`(n)make`
+`qmake`  
+`(n)make`  
+In case you don't want to run this file you can use the `CASCADE_INC_DIR` and `CASCADE_LIB_DIR` qmake
+variables instead :  
+`qmake "CASCADE_INC_DIR=occ_include_dir" "CASCADE_LIB_DIR=occ_library_dir"`  
+
+To enable optional gmio library, add this option to the qmake command line:  
+`"GMIO_ROOT=path_to_gmio"`
 
-# Screenshots
+# Screencast
 
-<img src="doc/screenshot_stl.png"/>
-<img src="doc/screenshot_irb.png"/>
+<img src="doc/screencast.gif"/>