|
@@ -23,9 +23,7 @@
|
|
|
<blockquote>
|
|
|
<p>Get started with:</p>
|
|
|
|
|
|
-<pre><code class="bash">git clone https://github.com/libigl/libigl.git
|
|
|
-cd libigl
|
|
|
-git submodule update --init --recursive
|
|
|
+<pre><code class="bash">git clone --recursive https://github.com/libigl/libigl.git
|
|
|
</code></pre>
|
|
|
</blockquote>
|
|
|
|
|
@@ -154,6 +152,25 @@ Eigen::Matrix<double, Eigen::Dynamic, 3> A;
|
|
|
them probably work just fine). This requires setting up unit testing, which is
|
|
|
a major <em>todo</em> for our development.</p>
|
|
|
|
|
|
+<h2 id="gitsubmodules">Git Submodules</h2>
|
|
|
+
|
|
|
+<p>Libigl uses git submodules for its <em>optional</em> dependencies,
|
|
|
+in particular, those needed by the OpenGL viewer to run the examples in the
|
|
|
+<a href="tutorial/tutorial.html">tutorial</a>. Git submodules allow use to treat clones of
|
|
|
+other libraries as sub-directories within ours while separating our commits.
|
|
|
+Read the <a href="http://git-scm.com/docs/git-submodule">documentation</a> for a detailed
|
|
|
+explanation, but essentially our libigl repo stores a hash for each of its
|
|
|
+subrepos containing which version to update to. When a change is introduced in
|
|
|
+a dependencies repo we can incorporate that change by pulling in our sub-repo
|
|
|
+and updating (i.e. committing) that change to the hash.</p>
|
|
|
+
|
|
|
+<p>When pulling new changes to libigl it’s also a good idea to update changes to
|
|
|
+subrepos:</p>
|
|
|
+
|
|
|
+<pre><code class="bash">git pull
|
|
|
+git submodule update -- recursive
|
|
|
+</code></pre>
|
|
|
+
|
|
|
<h2 id="howtocontribute">How to contribute</h2>
|
|
|
|
|
|
<p>If you are interested in joining development, please fork the repository and
|
|
@@ -213,7 +230,8 @@ few labs/companies/institutions using libigl:</p>
|
|
|
Jacobson</a> and <a href="http://www.inf.ethz.ch/personal/dpanozzo/">Daniele
|
|
|
Panozzo</a>. Please <a href="mailto:alecjacobson@gmail.com,daniele.panozzo@gmail.com">contact
|
|
|
us</a> if you have
|
|
|
-questions or comments. We are happy to get feedback!</p>
|
|
|
+questions or comments. For troubleshooting, please post an
|
|
|
+<a href="https://github.com/libigl/libigl/issues">issue</a> on github.</p>
|
|
|
|
|
|
<p>If you’re using libigl in your projects, quickly <a href="mailto:alecjacobson@gmail.com,daniele.panozzo@gmail.com">drop us a
|
|
|
note</a>. Tell us who you
|