clean up in readme

Former-commit-id: ea0e5539b054ce79ec7cd37bef0bc449818fa1b2

README.md

@@ -4,16 +4,29 @@
 
 <https://github.com/libigl/libigl/>
 
-libigl is a simple C++ geometry processing library. We have a wide functionality including construction of sparse discrete differential geometry operators and finite-elements matrices such as the contangent Laplacian and diagonalized mass matrix, simple facet and edge-based topology data structures, mesh-viewing utilities for OpenGL and GLSL, and many core functions for matrix manipulation which make [Eigen](http://eigen.tuxfamily.org) feel a lot more like MATLAB.
-
-It is first and foremost a header library. Each header file contains a single function. Most are tailored to operate on a generic triangle mesh stored in an n-by-3 matrix of vertex positions V and an m-by-3 matrix of triangle indices F. The library may also be [compiled](build/README.html) into a statically linked library, for faster compile times with your projects.
-
-We use the [Eigen](http://eigen.tuxfamily.org) library heavily in our code. Our group prototypes a lot in MATLAB, and we have a useful [conversion table](http://libigl.github.io/libigl/tutorial/matlab-to-eigen.html) from MATLAB to libigl/Eigen.
+libigl is a simple C++ geometry processing library. We have a wide
+functionality including construction of sparse discrete differential geometry
+operators and finite-elements matrices such as the contangent Laplacian and
+diagonalized mass matrix, simple facet and edge-based topology data structures,
+mesh-viewing utilities for OpenGL and GLSL, and many core functions for matrix
+manipulation which make [Eigen](http://eigen.tuxfamily.org) feel a lot more
+like MATLAB.
+
+It is first and foremost a header library. Each header file contains a single
+function. Most are tailored to operate on a generic triangle mesh stored in an
+n-by-3 matrix of vertex positions V and an m-by-3 matrix of triangle indices F.
+The library may also be [compiled](build/README.md) into a statically linked
+library, for faster compile times with your projects.
+
+We use the [Eigen](http://eigen.tuxfamily.org) library heavily in our code. Our
+group prototypes a lot in MATLAB, and we have a useful [conversion
+table](tutorial/matlab-to-eigen.html) from
+MATLAB to libigl/Eigen.
 
 # Tutorial
 
 As of version 1.0, libigl includes an introductory
-[tutorial](http://libigl.github.io/libigl/tutorial/tutorial.html) that covers
+[tutorial](tutorial/tutorial.html) that covers
 its basic functionalities.
 
 ## Installation
@@ -43,8 +56,8 @@ int main()
 }
 ```
 
-If you save this in `hello.cpp`, then you could compile this with (assuming Eigen
-  is installed in /opt/local/include/eigen3):
+If you save this in `hello.cpp`, then you could compile this with (assuming
+Eigen is installed in /opt/local/include/eigen3):
 
 ```bash
 gcc -I/opt/local/include/eigen3 -I./igl/ hello.cpp -o hello
@@ -61,24 +74,31 @@ Hello, mesh:
 ```
 
 ## Dependencies
-Dependencies are on a per-include basis and the majority of the functions in libigl
-depends only on the [Eigen](http://eigen.tuxfamily.org) library.
+Dependencies are on a per-include basis and the majority of the functions in
+libigl depends only on the [Eigen](http://eigen.tuxfamily.org) library.
 
 For more information see our [tutorial](tutorial/tutorial.html).
 
 # Download
-You can keep up to date by cloning a read-only copy of our GitHub [repository](https://github.com/libigl).
+You can keep up to date by cloning a read-only copy of our GitHub
+[repository](https://github.com/libigl).
 
 ## How to contribute
 
-If you are interested in joining development, please fork the repository and submit a [pull request](https://help.github.com/articles/using-pull-requests/) with your changes.
+If you are interested in joining development, please fork the repository and
+submit a [pull request](https://help.github.com/articles/using-pull-requests/)
+with your changes.
 
 ## License
-libigl is primarily [MPL2](http://www.mozilla.org/MPL/2.0/) licensed ([FAQ](http://www.mozilla.org/MPL/2.0/FAQ.html)). Some files contain third-party code under other licenses. We're currently in the processes of identifying these and marking appropriately.
+libigl is primarily [MPL2](http://www.mozilla.org/MPL/2.0/) licensed
+([FAQ](http://www.mozilla.org/MPL/2.0/FAQ.html)). Some files contain
+third-party code under other licenses. We're currently in the processes of
+identifying these and marking appropriately.
 
 ## Attribution
-If you use libigl in your academic projects, please cite the papers we implement
-as appropriate. To cite the library in general, you could use this BibTeX entry:
+If you use libigl in your academic projects, please cite the papers we
+implement as appropriate. To cite the library in general, you could use this
+BibTeX entry:
 
 ```bibtex
 @misc{libigl,
@@ -91,12 +111,16 @@ as appropriate. To cite the library in general, you could use this BibTeX entry:
 
 # Contact
 
-Libigl is a group endeavor led by [Alec Jacobson](http://www.cs.columbia.edu/~jacobson/) and [Daniele Panozzo](http://www.inf.ethz.ch/personal/dpanozzo/). Please
-[contact us](mailto:alecjacobson@gmail.com,daniele.panozzo@gmail.com) if you have questions or comments. We are happy to get feedback!
+Libigl is a group endeavor led by [Alec
+Jacobson](http://www.cs.columbia.edu/~jacobson/) and [Daniele
+Panozzo](http://www.inf.ethz.ch/personal/dpanozzo/). Please [contact
+us](mailto:alecjacobson@gmail.com,daniele.panozzo@gmail.com) if you have
+questions or comments. We are happy to get feedback!
 
 If you're using libigl in your projects, quickly [drop us a
-note](mailto:alecjacobson@gmail.com,daniele.panozzo@gmail.com). Tell us who you are and what you're using it for. This helps us apply for funding and justify spending time maintaining
-this.
+note](mailto:alecjacobson@gmail.com,daniele.panozzo@gmail.com). Tell us who you
+are and what you're using it for. This helps us apply for funding and justify
+spending time maintaining this.
 
 If you find bugs or have problems please use our [github issue tracking
 page](https://github.com/libigl/libigl/issues).

build/README.md

@@ -1,8 +1,9 @@
-# Compilation as a static library
+# Compiling libigl as a static library
 
-`Warning: compiling igl as a static library is considerably more difficult than using it as
-a header-only library. Do it only if you are experienced with C++ and you want to
-improve your compilation times.`
+> Warning: compiling libigl as a static library is considerably more difficult
+> than using it as a header-only library (see `../README.md` instead). Do it
+> only if you are experienced with C++ and you want to improve your compilation
+> times.
 
 Libigl is developed most often on Mac OS X, though has current users in Linux
 and Windows.
@@ -13,19 +14,19 @@ Libigl may also be compiled to a static library. This is advantageous when
 building a project with libigl, since when used as an header-only library can
 slow down compile times.
 
-To build the entire libigl library producing lib/libigl.a, issue:
+To build the entire libigl library producing `lib/libigl.a`, issue:
 
     cd build
     make lib
 
-You may need to edit Makefile.conf accordingly. Best to give yourself an
+You may need to edit `Makefile.conf` accordingly. Best to give yourself an
 `IGL_USERNAME` and add a custom install suite for yourself. Then you can enable
 appropriate extras.
 
 #### Extras ####
 Once you've set up an `IGL_USERNAME` and enabled extras within Makefile.conf.
-You can build the extra libraries (into lib/ligiglpng.a, lib/libiglmatlab.a,
-lib/libigltetgen.a, lib/libiglmosek.a, etc.) by issuing:
+You can build the extra libraries (into `lib/ligiglpng.a`, `lib/libiglmatlab.a`,
+`lib/libigltetgen.a`, `lib/libiglmosek.a`, etc.) by issuing:
 
     cd build
     make extras
@@ -38,9 +39,9 @@ You can make a slew of examples by issuing:
 
 #### External ####
 Finally there are a number of external libraries that we include in
-./external/ because they are either difficult to obtain or they have been
-patched for easier use with libigl. Please see the respective readmes in
-those directories.
+`./external/` because they are either difficult to obtain or they have been
+patched for easier use with libigl. Please see the respective readmes in those
+directories.
 
 
 ##### Installing AntTweakBar #####
@@ -181,8 +182,8 @@ This library extra utilizes tinyxml2 to read and write serialized classes
 containing Eigen matrices and other standard simple data-structures.
 
 ## Development ##
-Further documentation for developers is listed in tutorial.html,
-style_guidelines.html
+Further documentation for developers is listed in 
+[style_guidelines.html](../style_guidelines.html).
 
 ## License ##
 See `LICENSE.txt`

tutorial/tutorial.html.REMOVED.git-id

@@ -1 +1 @@
-bb9c175cf9dfae345668e73bfd5220e21b28ae0e
+a30fd5f786682eb951f8170826b3b3212240db31

tutorial/tutorial.md.REMOVED.git-id

@@ -1 +1 @@
-a7312d6b030f9fcaa361629f047902a139d01d1e
+227bf977c70fc9d17fb2b2823c0818e6205893d2