doc: include README as mainpage

doxygen supports markdown so we can expand the README with general interesting
information in markdown format and have it be the front page of the
documentation at the same time.

This requires renaming README to README.txt, but that's a relatively small
price to pay.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Jonas Ådahl <jadahl@gmail.com>

diff --git a/README b/README
deleted file mode 100644 (file)
index f55d7c8..0000000
--- a/README
+++ /dev/null
@@ -1,25 +0,0 @@
-libinput
-
-libinput is a library that handles input devices for display servers and other
-applications that need to directly deal with input devices.
-
-It provides device detection, device handling, input device event processing
-and abstraction so minimize the amount of custom input code the user of
-libinput need to provide the common set of functionality that users expect.
-
-Input event processing includes scaling touch coordinates, generating
-pointer events from touchpads, pointer acceleration, etc.
-
-libinput originates from weston, the Wayland reference compositor.
-
-The source code of libinput can be found at:
-http://cgit.freedesktop.org/wayland/libinput
-
-For more information, visit:
-http://www.freedesktop.org/wiki/Software/libinput/
-
-Bugs can be filed in the libinput component of Wayland:
-https://bugs.freedesktop.org/enter_bug.cgi?product=Wayland
-
-Online API documentation:
-http://wayland.freedesktop.org/libinput/doc/latest/modules.html

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..fabe304
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,30 @@
+/*!@mainpage
+
+libinput
+========
+
+libinput is a library that handles input devices for display servers and other
+applications that need to directly deal with input devices.
+
+It provides device detection, device handling, input device event processing
+and abstraction so minimize the amount of custom input code the user of
+libinput need to provide the common set of functionality that users expect.
+
+Input event processing includes scaling touch coordinates, generating
+pointer events from touchpads, pointer acceleration, etc.
+
+libinput originates from weston, the Wayland reference compositor.
+
+The source code of libinput can be found at:
+http://cgit.freedesktop.org/wayland/libinput
+
+For more information, visit:
+http://www.freedesktop.org/wiki/Software/libinput/
+
+Bugs can be filed in the libinput component of Wayland:
+https://bugs.freedesktop.org/enter_bug.cgi?product=Wayland
+
+Online API documentation:
+http://wayland.freedesktop.org/libinput/doc/latest/modules.html
+
+*/

diff --git a/doc/Makefile.am b/doc/Makefile.am
index a33638da6f04c9641114c2f94c29be4c34ad281e..8f05bd2cac30d50d70dbfe754670606815b5d6e2 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -5,7 +5,8 @@ if HAVE_DOXYGEN
 noinst_DATA = html/index.html
 
 header_files = \
-       $(top_srcdir)/src/libinput.h
+       $(top_srcdir)/src/libinput.h \
+       $(top_srcdir)/README.txt
 
 html/index.html: libinput.doxygen $(header_files)
        $(AM_V_GEN)$(DOXYGEN) $<

diff --git a/doc/libinput.doxygen.in b/doc/libinput.doxygen.in
index 865cf97488c5141c50e566f67f7627306d20be4b..9800f808a81acaf8fe7fa69dce56bb749949ebfe 100644 (file)
--- a/doc/libinput.doxygen.in
+++ b/doc/libinput.doxygen.in
@@ -753,7 +753,8 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @top_srcdir@/src/libinput.h
+INPUT                  = @top_srcdir@/src/libinput.h \
+                        @top_srcdir@/README.txt
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/src/libinput.h b/src/libinput.h
index e2a3eef025a3a7d94a47ecdee34e2bcd3bb3404a..682e16f2b348aabb2b6b75c50aa942cccb074ed4 100644 (file)
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -35,13 +35,6 @@ extern "C" {
        __attribute__ ((format (printf, _format, _args)))
 #define LIBINPUT_ATTRIBUTE_DEPRECATED __attribute__ ((deprecated))
 
-/**
- * @mainpage
- * libinput is a generic input device handling library. It abstracts
- * commonly-used concepts such as keyboard, pointer and touchpad handling
- * behind an API.
- */
-
 /**
  * @page tpbuttons Touchpad button behavior
  *