diff --git a/unsupported/README.txt b/unsupported/README.txt index 7783152c7..f265f3849 100644 --- a/unsupported/README.txt +++ b/unsupported/README.txt @@ -1,10 +1,31 @@ This directory contains several contributions from various users. They are provided "as is", without any support. Nevertheless, they are subject to be included in Eigen in the future. + +In order to use an unsupported module you have to do either: + + - add the path_to_eigen2/unsupported directory to your include path and do: + #include + + - or directly do: + #include + + 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 +Any kind of contributions are much appreciated, even very preliminary ones. +However, it: + - must rely on Eigen, + - must be highly related to math, + - should have some general purpose in the sense that it could + potentially become an offical Eigen module (or be merged into another one). + +In doubt feel free to contact us. For instance, if your addons is very too specific +but it shows an interesting way of using Eigen, then it could be a nice demo. + + This diectory is organized as follow: unsupported/Eigen/ModuleHeader1 @@ -25,5 +46,5 @@ 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 +The .html files are generate in: build_dir/doc/html/unsupported/ + diff --git a/unsupported/doc/Overview.dox b/unsupported/doc/Overview.dox new file mode 100644 index 000000000..c09f06857 --- /dev/null +++ b/unsupported/doc/Overview.dox @@ -0,0 +1,13 @@ +namespace Eigen { + +o /** \mainpage Eigen's unsupported modules + +This is the API documentation for Eigen's unsupported modules. + +These modules are contributions from various users. They are provided "as is", without any support. + +Don't miss the official Eigen documentation. + +*/ + +}