Browse Source

updated html and added --recursive in the tutorial readme

Former-commit-id: 56000af67166d63218a39f0d46bb380ad8cd9c46
Daniele Panozzo 10 years ago
parent
commit
8ac5993548
4 changed files with 34 additions and 117 deletions
  1. 10 2
      index.html
  2. 22 113
      optional/index.html
  3. 1 1
      tutorial/tutorial.html.REMOVED.git-id
  4. 1 1
      tutorial/tutorial.md.REMOVED.git-id

+ 10 - 2
index.html

@@ -16,7 +16,7 @@
 
 
 <figure>
 <figure>
 <img src="libigl-teaser.png" alt="" />
 <img src="libigl-teaser.png" alt="" />
-<figcaption></figcaption></figure>
+</figure>
 
 
 <p><a href="https://github.com/libigl/libigl/">https://github.com/libigl/libigl/</a></p>
 <p><a href="https://github.com/libigl/libigl/">https://github.com/libigl/libigl/</a></p>
 
 
@@ -98,6 +98,14 @@ libigl depends only on the <a href="http://eigen.tuxfamily.org">Eigen</a> librar
 
 
 <p>For more information see our <a href="tutorial/tutorial.html">tutorial</a>.</p>
 <p>For more information see our <a href="tutorial/tutorial.html">tutorial</a>.</p>
 
 
+<h3 id="optionaldependencies">Optional dependencies</h3>
+
+<p>Libigl compartmentalizes its <strong>optional</strong> dependences via its directory
+organization in the <code>include/</code> folder. All header files located <em>directly</em> in
+the <code>include/igl/</code> folder have only stl and Eigen as dependencies. For example,
+all of the headers that depend on CGAL are located in <code>include/igl/cgal</code>. For a
+full list of <em>optional</em> dependencies check <code>optional/CMakeLists.txt</code>.</p>
+
 <h3 id="gccandtheoptionalcgaldependency">GCC and the optional CGAL dependency</h3>
 <h3 id="gccandtheoptionalcgaldependency">GCC and the optional CGAL dependency</h3>
 
 
 <p>The <code>include/igl/cgal/*.h</code> headers depend on CGAL. It has come to our attention
 <p>The <code>include/igl/cgal/*.h</code> headers depend on CGAL. It has come to our attention
@@ -118,7 +126,7 @@ avoiding OpenMP on Windows or proceeding with caution.</p>
 
 
 <h2 id="knownissues">Known Issues</h2>
 <h2 id="knownissues">Known Issues</h2>
 
 
-<p>We really heavily on Eigen. Nearly all inputs and outputs are Eigen matrices of
+<p>We rely heavily on Eigen. Nearly all inputs and outputs are Eigen matrices of
 some kind. However, we currently <em>only</em> officially support Eigen&#8217;s default
 some kind. However, we currently <em>only</em> officially support Eigen&#8217;s default
 column-major ordering. That means, we <strong>do not</strong> expect our code to work for
 column-major ordering. That means, we <strong>do not</strong> expect our code to work for
 matrices using the <code>Eigen::RowMajor</code> flag. If you can, change definitions like:</p>
 matrices using the <code>Eigen::RowMajor</code> flag. If you can, change definitions like:</p>

+ 22 - 113
optional/index.html

@@ -36,10 +36,20 @@ from <em>this current directory</em>: issue:</p>
 
 
 <pre><code>mkdir -p ../lib
 <pre><code>mkdir -p ../lib
 cd ../lib
 cd ../lib
-cmake -DCMAKE_BUILD_TYPE=Release ..
+cmake -DCMAKE_BUILD_TYPE=Release ../optional
 make
 make
 </code></pre>
 </code></pre>
 
 
+<h4 id="warnings">Warnings</h4>
+
+<p>You should expect to see a few linker warnings of the form:</p>
+
+<pre><code>/opt/local/bin/ranlib: file: libigl.a(*.cpp.o) has no symbols
+</code></pre>
+
+<p>These are (admittedly unpopular) functions that have never been used by us
+statically so we haven&#8217;t explicit instantiations (yet).</p>
+
 <h4 id="examples">Examples</h4>
 <h4 id="examples">Examples</h4>
 
 
 <p>You can make a slew of examples by issuing:</p>
 <p>You can make a slew of examples by issuing:</p>
@@ -50,45 +60,11 @@ make
 
 
 <h4 id="external">External</h4>
 <h4 id="external">External</h4>
 
 
-<blockquote>
-<p><strong>Deprecation notice</strong> All external libraries will be absorbed by libigl or
-moved to separate git sub-repositories in the near future. The following
-instructions are subject to immediate change.</p>
-</blockquote>
-
 <p>Finally there are a number of external libraries that we include in
 <p>Finally there are a number of external libraries that we include in
 <code>./external/</code> because they are either difficult to obtain or they have been
 <code>./external/</code> because they are either difficult to obtain or they have been
 patched for easier use with libigl. Please see the respective readmes in those
 patched for easier use with libigl. Please see the respective readmes in those
-directories.</p>
-
-<h5 id="installinganttweakbar">Installing AntTweakBar</h5>
-
-<p>To build a static AntTweakBar library on Mac OS X issue:</p>
-
-<pre><code>cd external/AntTweakBar/src
-make -f Makefile.osx.igl
-</code></pre>
-
-<h5 id="installingtetgen">Installing Tetgen</h5>
-
-<p>To build the tetgen library and executable on Mac OS X issue:</p>
-
-<pre><code>cd external/tetgen
-make clean
-rm -f obj/*.o
-make -f Makefile.igl tetgen
-rm -f obj/*.o
-make -f Makefile.igl tetlib
-</code></pre>
-
-<h5 id="installingmedit">Installing medit</h5>
-
-<p>To build the igl version of the medit executable on Mac OS X issue:</p>
-
-<pre><code>cd external/medit
-make -C libmesh
-make -f Makefile.igl medit
-</code></pre>
+directories or build the tutorial using cmake, which will recursively build all
+dependencies.</p>
 
 
 <h5 id="installingembree2.0">Installing Embree 2.0</h5>
 <h5 id="installingembree2.0">Installing Embree 2.0</h5>
 
 
@@ -106,82 +82,18 @@ make
 #sudo make install
 #sudo make install
 </code></pre>
 </code></pre>
 
 
-<h5 id="installingtinyxml2">Installing tinyxml2</h5>
-
-<p>To build the a static tinyxml2 library on Mac OS X issue:</p>
-
-<pre><code>cd external/tinyxml2
-cmake .
-make
-</code></pre>
-
-<h5 id="installingyimg">Installing YImg</h5>
-
-<p>To build the a static YImg library on Mac OS X issue:</p>
-
-<pre><code>cd external/yimg
-make
-</code></pre>
-
-<p>You may need to install libpng. Systems with X11 might find this already
-installed at <code>/usr/X11/lib</code>.</p>
-
-<h3 id="windowsexperimental">Windows (Experimental)</h3>
-
-<blockquote>
-<p><strong>Deprecation notice</strong> Windows users should run cmake on the <code>CMakeLists.txt</code>
-file in the current directory.</p>
-</blockquote>
-
-<p>To build a static library (.lib) on windows, open Visual Studio 2010.</p>
-
-<ul>
-<li>New &gt; Project &#8230;</li>
-<li>Visual C++ &gt; Win32</li>
-<li>Win32 Console Application</li>
-<li>Name: libiglVisualStudio</li>
-<li>Uncheck &#8220;Create directory for solution&#8221;</li>
-<li>Then hit OK, and then Next</li>
-<li>Check &#8220;Static Library&#8221;</li>
-<li>Uncheck &#8220;Precompiled headers&#8221;</li>
-<li>Add all include/igl/*.cpp to the sources directory</li>
-<li>Add all include/igl/*.h to the headers directory</li>
-<li>Open Project &gt; libigl Properties&#8230;</li>
-<li>Add the path to eigen3 to the include paths</li>
-<li>Change the target name to libigl</li>
-<li>Build and pray (this should create libigl.lib</li>
-</ul>
-
-<p><a href="http://msdn.microsoft.com/en-us/library/ms235627(v=vs.80).aspx">Source</a></p>
-
-<h2 id="examples">Examples</h2>
-
-<p>To get started, we advise that you take a look at a few examples:</p>
-
-<pre><code>./examples/hello-world/
-
-./examples/meshio/
-
-./examples/basic-topology/
-
-./examples/ReAntTweakBar/
-</code></pre>
-
 <h2 id="extras">Extras</h2>
 <h2 id="extras">Extras</h2>
 
 
-<p>Libigl compartmentalizes dependences via its organization into a <em>main</em> libigl
-library and &#8220;extras.&#8221;</p>
-
 <h3 id="bbw">bbw</h3>
 <h3 id="bbw">bbw</h3>
 
 
 <p>This library extra contains functions for computing Bounded Biharmonic Weights, can
 <p>This library extra contains functions for computing Bounded Biharmonic Weights, can
 be used with and without the <a href="#mosek">mosek</a> extra via the <code>IGL_NO_MOSEK</code>
 be used with and without the <a href="#mosek">mosek</a> extra via the <code>IGL_NO_MOSEK</code>
 macro.</p>
 macro.</p>
 
 
-<h3 id="boost">boost</h3>
+<h3 id="boolean">boolean</h3>
 
 
-<p>This library extra utilizes the graph functions in the boost library for find
-connected components and performing breadth-first traversals.</p>
+<p>This library extra contains functions for computing mesh-mesh booleans,
+depending on CGAL and optionally Cork.</p>
 
 
 <h3 id="cgal">cgal</h3>
 <h3 id="cgal">cgal</h3>
 
 
@@ -206,18 +118,15 @@ quadratic programs.</p>
 
 
 <p>This library extra uses <code>libpng</code> and <code>YImage</code> to read and write <code>.png</code> files.</p>
 <p>This library extra uses <code>libpng</code> and <code>YImage</code> to read and write <code>.png</code> files.</p>
 
 
-<h3 id="svd3x3">svd3x3</h3>
+<h3 id="tetgen">tetgen</h3>
 
 
-<p>This library extra implements &#8220;as-rigid-as-possible&#8221; (ARAP) deformation
-techniques using the fast singular value decomposition routines
-written specifically for 3x3 matrices to use <code>SSE</code> intrinsics. This extra can
-still be compiled without sse support and support should be determined
-automatically at compile time via the <code>__SSE__</code> macro.</p>
+<p>This library extra provides a simplified wrapper to the tetgen 3d tetrahedral
+meshing library.</p>
 
 
-<h3 id="tetgen">tetgen</h3>
+<h3 id="triangle">Triangle</h3>
 
 
-<p>This library extra provides a simplified wrapper to the tetgen 3d tetrahedral meshing
-library.</p>
+<p>This library extra provides a simplified wrapper to the triangle 2d triangle
+meshing library.</p>
 
 
 <h3 id="viewer">viewer</h3>
 <h3 id="viewer">viewer</h3>
 
 

+ 1 - 1
tutorial/tutorial.html.REMOVED.git-id

@@ -1 +1 @@
-123e5a9852152af5548e1130853e597265d897f5
+918f18e58f2b05bc303ee3b08c8b57178bd816e6

+ 1 - 1
tutorial/tutorial.md.REMOVED.git-id

@@ -1 +1 @@
-c2c64bc4dca6502cf13e254fa512d9f9feca182f
+d01b1d08eed6f827504ca91822bfa23543c7858d