diff options
| author | Peter Hutterer <peter.hutterer@who-t.net> | 2017-04-20 15:54:55 +1000 |
|---|---|---|
| committer | Peter Hutterer <peter.hutterer@who-t.net> | 2017-04-25 10:56:51 +1000 |
| commit | 938aa25843732c3837c9f4cb5af283b1771207dd (patch) | |
| tree | 6139f53db55119331bd0cc6fcf4e995ca8034a0a | |
| parent | 7b9aa96d0230b9b1328c43e8421ddea3ffa310cb (diff) | |
Rename README to README.md, include properly from doxygen
As of doxygen 1.8.3 (Dec 2012) doxygen can include a README.md directly as
mainpage. This avoids the ugly doxygen bits we have in the current README.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
| -rw-r--r-- | README.md (renamed from README.txt) | 4 | ||||
| -rw-r--r-- | configure.ac | 4 | ||||
| -rw-r--r-- | doc/Makefile.am | 2 | ||||
| -rw-r--r-- | doc/libinput.doxygen.in | 3 |
4 files changed, 5 insertions, 8 deletions
@@ -1,5 +1,3 @@ -/*!@mainpage - libinput ======== @@ -94,5 +92,3 @@ libinput is licensed under the MIT license. See the [COPYING](http://cgit.freedesktop.org/wayland/libinput/tree/COPYING) file for the full license information. - -*/ diff --git a/configure.ac b/configure.ac index 61a964c..82a2f22 100644 --- a/configure.ac +++ b/configure.ac @@ -117,13 +117,13 @@ if test "x$build_documentation" = "xyes"; then AC_MSG_CHECKING([for compatible doxygen version]) doxygen_version=`$DOXYGEN --version` - AS_VERSION_COMPARE([$doxygen_version], [1.6.0], + AS_VERSION_COMPARE([$doxygen_version], [1.8.3], [AC_MSG_RESULT([no]) DOXYGEN=""], [AC_MSG_RESULT([yes])], [AC_MSG_RESULT([yes])]) if test "x$DOXYGEN" = "x"; then - AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.6+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation]) + AC_MSG_ERROR([Doxygen $doxygen_version too old. Doxygen 1.8.3+ required for documentation build. Install required doxygen version or disable the documentation using --disable-documentation]) fi AC_PATH_PROG(DOT, dot) diff --git a/doc/Makefile.am b/doc/Makefile.am index 50fab04..8af0f33 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -5,7 +5,7 @@ EXTRA_DIST = \ header_files = \ $(top_srcdir)/src/libinput.h \ - $(top_srcdir)/README.txt \ + $(top_srcdir)/README.md \ $(srcdir)/absolute-axes.dox \ $(srcdir)/absolute-coordinate-ranges.dox \ $(srcdir)/building.dox \ diff --git a/doc/libinput.doxygen.in b/doc/libinput.doxygen.in index 300d2f7..3dd4101 100644 --- a/doc/libinput.doxygen.in +++ b/doc/libinput.doxygen.in @@ -9,7 +9,7 @@ EXTRACT_STATIC = YES MAX_INITIALIZER_LINES = 0 QUIET = YES INPUT = @top_srcdir@/src/libinput.h \ - @top_srcdir@/README.txt + @top_srcdir@/README.md IMAGE_PATH = @top_srcdir@/doc/svg \ @top_srcdir@/doc/dot GENERATE_HTML = YES @@ -28,3 +28,4 @@ HTML_FOOTER = @top_srcdir@/doc/style/footer.html HTML_EXTRA_STYLESHEET = @top_srcdir@/doc/style/bootstrap.css \ @top_srcdir@/doc/style/customdoxygen.css \ @top_srcdir@/doc/style/libinputdoxygen.css +USE_MDFILE_AS_MAINPAGE = @top_srcdir@/README.md |