dust3d/docs/builds.rst

Building Dust3D
-------------------

Overview
==========
The core mesh algorithms of Dust3D written in Rust language, located in meshlite repository,

    https://github.com/huxingyi/meshlite

The UI of Dust3D built in Qt5, the only thirdparty dependency is CGAL library, however, CGAL will introduce some new dependencies, such as boost and gmp library.

Prerequisites
===============
* CGAL

    https://www.cgal.org/

* Rust

    https://www.rust-lang.org/en-US/install.html


Building
==========

Here is the snapshot of the command line of one build, you may use different defines on your system. If you encounter build issues, please follow the ci files step by step,

    https://github.com/huxingyi/dust3d/blob/master/appveyor.yml
    https://github.com/huxingyi/dust3d/blob/master/.travis.yml

* Windows

.. code-block:: none

    From Start Menu, Open Visual Studio 2017 Tools Command Prompt:
    C:\Program Files\Microsoft Visual Studio\2017\Community>cd C:\Users\IEUser\Desktop\dust3d
    C:\Users\IEUser\Desktop\dust3d>qmake DEFINES+=BOOST_INCLUDEDIR=C:\dev\boost_1_55_0\boost_1_55_0 DEFINES+=CGAL_DIR=C:\dev\CGAL-4.11.1
    C:\Users\IEUser\Desktop\dust3d>nmake -f Makefile.Release

* Mac

.. code-block:: sh

    $ cd /Users/jeremy/Desktop
    $ git clone https://github.com/huxingyi/meshlite.git
    $ cd meshlite
    $ cargo build --release
    $ cp include/meshlite.h /Users/jeremy/Repositories/dust3d/thirdparty/meshlite/meshlite.h
    $ cp target/release/libmeshlite.dylib /Users/jeremy/Repositories/dust3d/thirdparty/meshlite/libmeshlite.dylib
    
    $ cd /Users/jeremy/Repositories/dust3d
    $ qmake -spec macx-xcode
    Open dust3d.xcodeproj in Xcode and build