Bug 369660 - Covert README to markdown and use for Doxygen main page
Summary: Covert README to markdown and use for Doxygen main page
Status: RESOLVED WORKSFORME
Alias: None
Product: libkface
Classification: Frameworks and Libraries
Component: General (show other bugs)
Version: unspecified
Platform: Other Linux
: NOR minor
Target Milestone: ---
Assignee: imaging-bugs-null
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2016-10-03 03:10 UTC by jflemer
Modified: 2022-11-25 05:22 UTC (History)
0 users

See Also:
Latest Commit:
Version Fixed In:


Attachments
patch (6.48 KB, patch)
2016-10-03 03:11 UTC, jflemer
Details

Note You need to log in before you can comment on or make changes to this bug.
Description jflemer 2016-10-03 03:10:20 UTC
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-devel@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-devel@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
Comment 1 jflemer 2016-10-03 03:11:12 UTC
Created attachment 101382 [details]
patch
Comment 2 Justin Zobel 2022-10-26 03:06:58 UTC
Thank you for reporting this bug in KDE software. As it has been a while since this issue was reported, can we please ask you to see if you can reproduce the issue with a recent software version?

If you can reproduce the issue, please change the status to "REPORTED" when replying. Thank you!
Comment 3 Bug Janitor Service 2022-11-10 05:12:13 UTC
Dear Bug Submitter,

This bug has been in NEEDSINFO status with no change for at least
15 days. Please provide the requested information as soon as
possible and set the bug status as REPORTED. Due to regular bug
tracker maintenance, if the bug is still in NEEDSINFO status with
no change in 30 days the bug will be closed as RESOLVED > WORKSFORME
due to lack of needed information.

For more information about our bug triaging procedures please read the
wiki located here:
https://community.kde.org/Guidelines_and_HOWTOs/Bug_triaging

If you have already provided the requested information, please
mark the bug as REPORTED so that the KDE team knows that the bug is
ready to be confirmed.

Thank you for helping us make KDE software even better for everyone!
Comment 4 Bug Janitor Service 2022-11-25 05:22:29 UTC
This bug has been in NEEDSINFO status with no change for at least
30 days. The bug is now closed as RESOLVED > WORKSFORME
due to lack of needed information.

For more information about our bug triaging procedures please read the
wiki located here:
https://community.kde.org/Guidelines_and_HOWTOs/Bug_triaging

Thank you for helping us make KDE software even better for everyone!