doc: reference README.md as main page for doxygen

README.md

@@ -1,27 +1,35 @@
-/*!
+GeomIO: C library for geometry input/output
+==============================
 
-\mainpage
+This is GeomIO v0.1dev
+
+GeomIO is a reusable ANSI C library whose purpose is to provide complete
+I/O support for various CAD file formats (eg. STL)
 
 
-\section intro_sec Introduction
+Building GeomIO
+==================
 
-This is GeomIO library v0.1
+GeomIO can be built with CMake, by default a shared library is generated.
+    1. For an out-of-source build, create a directory where the build will take
+         place (say build/)
+    2. Call cmake, passing as argument the directory where is located
+         CMakeLists.txt
+    3. (n)make
+    4. (n)make install
 
-Check source code at : https://github.com/fougsys/gmio
+Read CMakeLists.txt to figure out how to build debug and release libraries.
 
-GeomIO is a fast and portable C library for reading and writing geometry data.
+For the first use of GeomIO, you should run unit tests:
+    (n)make check
 
 
-\section build_sec BUILDING GeomIO library
-
-The GeomIO library can be built with cmake.
-Once makefiles are generated, init tests can be run with "make check"
-
-\section reportbug_sec HOW TO REPORT A BUG
+How to report a bug
+===================
 
 If you think you have found a bug in GeomIO, we would like to hear
 about it so that we can fix it. The GeomIO bug tracking system is
-open to the public at https://github.com/fougsys/gmio/issues.
+open to the public at https://github.com/fougsys/fougtools/issues.
 
 Before reporting a bug, please use the bug-tracker's search functions
 to see if the issue is already known.
@@ -34,12 +42,13 @@ what configure options it was compiled with.
 If the problem you are reporting is only visible at run-time, try to
 create a small test program that shows the problem when run.
 
-       
-\section license_sec LICENSE
 
-This software is governed by the CeCILL-C license under French law and
+License
+=======
+
+This software is governed by the CeCILL-B license under French law and
 abiding by the rules of distribution of free software.  You can  use,
-modify and/ or redistribute the software under the terms of the CeCILL-C
+modify and/ or redistribute the software under the terms of the CeCILL-B
 license as circulated by CEA, CNRS and INRIA at the following URL
 http://www.cecill.info
 
@@ -61,6 +70,4 @@ data to be ensured and,  more generally, to use and operate it in the
 same conditions as regards security.
 
 The fact that you are presently reading this means that you have had
-knowledge of the CeCILL-C license and that you accept its terms.
-
-*/
+knowledge of the CeCILL-B license and that you accept its terms.

doc/Doxyfile

@@ -38,7 +38,7 @@ PROJECT_NUMBER = 0.1.0
 # for a project that appears at the top of each page and should give viewer 
 # a quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "Fast, portable geometry input/output"
+PROJECT_BRIEF          = "Fast, portable geometry input/output C library"
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is 
 # included in the documentation. The maximum height of the logo should not 
@@ -249,6 +249,8 @@ EXTENSION_MAPPING      =
 
 MARKDOWN_SUPPORT       = YES
 
+USE_MDFILE_AS_MAINPAGE  = ../README.md
+
 # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 
 # to include (a tag file for) the STL sources as input, then you should 
 # set this tag to YES in order to let doxygen match functions declarations and 
@@ -655,7 +657,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = ../src  main_page.cpp
+INPUT                  = ../src
 
 # This tag can be used to specify the character encoding of the source files 
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is