From 454adf7b32a58586cb1f7d86f16e8bedd530bb5c Mon Sep 17 00:00:00 2001 From: Jeremy Hu Date: Wed, 18 Apr 2018 22:05:20 +0800 Subject: [PATCH] Add build overview docs --- docs/builds.rst | 33 +++++++++++++++++++++++++++++---- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/docs/builds.rst b/docs/builds.rst index 91a85d34..571030d2 100644 --- a/docs/builds.rst +++ b/docs/builds.rst @@ -1,8 +1,34 @@ Building Dust3D ------------------- -Windows -======= +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 @@ -11,8 +37,7 @@ Windows 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 -======= +* Mac .. code-block:: sh