Browse Source

reformat known issue

Former-commit-id: e833f8eab978bbf95c237194cfc718d98ae13c8b
Alec Jacobson 10 years ago
parent
commit
4e8f010c8c
1 changed files with 18 additions and 22 deletions
  1. 18 22
      README.md

+ 18 - 22
README.md

@@ -95,6 +95,24 @@ caution.
 You can keep up to date by cloning a read-only copy of our GitHub
 [repository](https://github.com/libigl).
 
+## Known Issues
+We really heavily on Eigen. Nearly all inputs and outputs are Eigen matrices of
+some kind. However, we currently _only_ support Eigen's default column-major
+ordering. That means, we **do not** expect our code to work for matrices using
+the `Eigen::RowMajor` flag. If you can, change definitions like:
+```cpp
+Eigen::Matrix<double, Eigen::Dynamic, 3, Eigen::RowMajor> A;
+```
+to
+```cpp
+Eigen::Matrix<double, Eigen::Dynamic, 3, Eigen::ColMajor> A;
+// or simply
+Eigen::Matrix<double, Eigen::Dynamic, 3> A;
+```
+We hope to fix this, or at least identify which functions are safe (many of
+them probably work just fine). This requires setting up unit testing, which is
+a major _todo_ for our development.
+
 ## How to contribute
 
 If you are interested in joining development, please fork the repository and
@@ -121,28 +139,6 @@ BibTeX entry:
 }
 ```
 
-## Known Issues
-We really heavily on Eigen. Nearly all inputs and outputs are Eigen matrices of
-some kind. However, we currently _only_ support Eigen's default column-major
-ordering. That means, we **do not** expect our code to work for matrices using
-the `Eigen::RowMajor` flag. If you can, change definitions like:
-
-```cpp
-Eigen::Matrix<Float, Eigen::Dynamic, 3, Eigen::RowMajor> A;
-```
-
-to
-
-```cpp
-Eigen::Matrix<Float, Eigen::Dynamic, 3, Eigen::ColMajor> A;
-// or simply
-Eigen::Matrix<Float, Eigen::Dynamic, 3> A;
-```
-
-We hope to fix this, or at least identify which functions are safe (many of
-them probably work just fine). This requires setting up unit testing, which is
-a major _todo_ for our development.
-
 ## Contact
 
 Libigl is a group endeavor led by [Alec