aboutsummaryrefslogtreecommitdiffhomepage
path: root/unsupported/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'unsupported/README.txt')
-rw-r--r--unsupported/README.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/unsupported/README.txt b/unsupported/README.txt
index 85ae798aa..7783152c7 100644
--- a/unsupported/README.txt
+++ b/unsupported/README.txt
@@ -4,3 +4,26 @@ included in Eigen in the future.
If you are interested in contributing to one of them, or have other stuff
you would like to share, feel free to contact us:
http://eigen.tuxfamily.org/index.php?title=Main_Page#Mailing_list
+
+This diectory is organized as follow:
+
+unsupported/Eigen/ModuleHeader1
+unsupported/Eigen/ModuleHeader2
+unsupported/Eigen/...
+unsupported/Eigen/src/Module1/SourceFile1.h
+unsupported/Eigen/src/Module1/SourceFile2.h
+unsupported/Eigen/src/Module1/...
+unsupported/Eigen/src/Module2/SourceFile1.h
+unsupported/Eigen/src/Module2/SourceFile2.h
+unsupported/Eigen/src/Module2/...
+unsupported/Eigen/src/...
+unsupported/doc/snippets/.cpp <- code snippets for the doc
+unsupported/doc/examples/.cpp <- examples for the doc
+unsupported/doc/TutorialModule1.dox
+unsupported/doc/TutorialModule2.dox
+unsupported/doc/...
+unsupported/test/.cpp <- unit test files
+
+The documentation is generated at the same time than the main Eigen documentation.
+The .html files are generate in:
+build_dir/doc/html/unsupported/ \ No newline at end of file