https://bugs.kde.org/show_bug.cgi?id=369660
Bug ID: 369660
Summary: Covert README to markdown and use for Doxygen main
page
Product: libkface
Version: unspecified
Platform: Other
OS: Linux
Status: UNCONFIRMED
Severity: minor
Priority: NOR
Component: General
Assignee: kde-imag...@kde.org
Reporter: jfle...@alum.rpi.edu
Make the doxygen output have a non-blank main page, instead use the current
readme.
Reproducible: Always
Steps to Reproduce:
1. cd src && doxygen
2. www-browser `pwd`/src/html/index.html
Actual Results:
No product description
Expected Results:
Product description
Patch
---
README | 61 ------------------------------------------------
README.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
src/Doxyfile | 3 ++-
3 files changed, 77 insertions(+), 62 deletions(-)
delete mode 100644 README
create mode 100644 README.md
diff --git a/README b/README
deleted file mode 100644
index d3367e8..0000000
--- a/README
+++ /dev/null
@@ -1,61 +0,0 @@
-LibKFace Library interface for KDE
-
-This library is a part of digiKam project (http://www.digikam.org)
-
--- AUTHORS ------------------------------------------------------------
-
-See AUTHORS file for details.
-
--- ABOUT --------------------------------------------------------------
-
-Libkface is a Qt/C++ library to perform face detection and recognition over
pictures
-
-This library is used by kipi-plugins, digiKam and others kipi host programs.
-
-The library documentation is available on header files.
-
--- DEPENDENCIES -------------------------------------------------------
-
-CMake >= 2.8.12 http://www.cmake.org
-ECM >= 1.1.0
https://projects.kde.org/projects/kdesupport/extra-cmake-modules
-libqt >= 5.2.0 http://qt-project.org
-libopencv >= 2.4.9 http://opencv.willowgarage.com/wiki
(with opencv 'haarcascades' data files)
-
-CMake compilation options to custom libkface:
-
-Use CMake "-DENABLE_OPENCV3=on" flag to compile libkface source code
using OpenCV3 instead OpenCV2 (disabled by default).
- OpenCV3 support needs extra contrib
modules package, especially 'face' and 'legacy' components.
-
--- INSTALL ------------------------------------------------------------
-
-Usual CMake options:
-
--DCMAKE_INSTALL_PREFIX : decide where the program will be install on your
computer.
--DCMAKE_BUILD_TYPE : decide which type of build you want. You can chose
between "debug", "profile", "relwithdebinfo" and "release". The default is
"relwithdebinfo" (-O2 -g).
-
-Note: To know KDE install path on your computer, use 'kf5-config --prefix'
command line like this (with debug object enabled):
-
-"cmake . -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=`kf5-config
--prefix`"
-
--- CONTACT ------------------------------------------------------------
-
-If you have questions, comments, suggestions to make do email at:
-
-digikam-de...@kde.org
-
-IRC channel from freenode.net server:
-
-#digikam
-
--- BUGS ---------------------------------------------------------------
-
-IMPORTANT : the bugreports and the wishlist are hosted by the KDE bugs report
-system who can be contacted by the standard Kde help menu of the plugins
dialog.
-A mail will be automatically sent to the digiKam devel mailing list.
-There is no need to contact directly the digiKam mailing list for a bug report
-or a devel wish.
-
-The current digiKam bugs and devel wish reported to the Kde bugs report can be
seen
-at this url:
-
-http://bugs.kde.org/buglist.cgi?product=digikam&component=libkface&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d7dc4bf
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+LibKFace Library interface for KDE {#mainpage}
+==================================
+
+This library is a part of digiKam project (http://www.digikam.org)
+
+AUTHORS
+-------
+
+See AUTHORS file for details.
+
+ABOUT
+-----
+
+Libkface is a Qt/C++ library to perform face detection and recognition over
+pictures.
+
+This library is used by kipi-plugins, digiKam and others kipi host programs.
+
+The library documentation is available on header files.
+
+DEPENDENCIES
+------------
+
+| Name | Version | Link |
+| ---------- | --------- | ------------------------------------------------- |
+| CMake | >= 2.8.12 | http://www.cmake.org |
+| ECM | >= 1.1.0 |
https://projects.kde.org/projects/kdesupport/extra-cmake-modules |
+| libqt | >= 5.2.0 | http://qt-project.org |
+| libopencv | >= 2.4.9 | http://opencv.willowgarage.com/wiki (with opencv
'haarcascades' data files) |
+
+CMake compilation options to custom libkface:
+
+Use CMake `-DENABLE_OPENCV3=on` flag to compile libkface source code using
+OpenCV3 instead OpenCV2 (disabled by default). OpenCV3 support needs extra
+contrib modules package, especially 'face' and 'legacy' components.
+
+INSTALL
+-------
+
+Usual CMake options:
+
+| Option | Description |
+| ------------------------ | ----------------------------------------------- |
+| `-DCMAKE_INSTALL_PREFIX` | decide where the program will be install on your
computer |
+| `-DCMAKE_BUILD_TYPE` | decide which type of build you want: `debug`,
`profile`, `relwithdebinfo` and `release`; default is `relwithdebinfo` (`-O2
-g`) |
+
+Note: To know KDE install path on your computer, use `kf5-config --prefix`
+command line like this (with debug object enabled):
+
+ cmake . -DCMAKE_BUILD_TYPE=debug -DCMAKE_INSTALL_PREFIX=`kf5-config
--prefix`
+
+CONTACT
+-------
+
+If you have questions, comments, suggestions to make do email at:
+
+digikam-de...@kde.org
+
+IRC channel from freenode.net server:
+
+ #digikam
+
+BUGS
+----
+
+**IMPORTANT**: the bugreports and the wishlist are hosted by the KDE bugs
report
+system who can be contacted by the standard Kde help menu of the plugins
dialog.
+A mail will be automatically sent to the digiKam devel mailing list.
+There is no need to contact directly the digiKam mailing list for a bug report
+or a devel wish.
+
+The current digiKam bugs and devel wish reported to the Kde bugs report can be
seen
+at this url:
+
+http://bugs.kde.org/buglist.cgi?product=digikam&component=libkface&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED
diff --git a/src/Doxyfile b/src/Doxyfile
index 8666710..5461cbb 100644
--- a/src/Doxyfile
+++ b/src/Doxyfile
@@ -355,7 +355,8 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ./
+INPUT = ./ \
+ ../README.md
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
--
2.7.4
--
You are receiving this mail because:
You are watching all bug changes.
