[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [digikam] /: API doc
From:       Gilles Caulier <null () kde ! org>
Date:       2018-07-11 19:55:35
Message-ID: E1fdLD5-0006Jt-EG () code ! kde ! org
[Download RAW message or body]

Git commit 570c9de1f00ffbf59cd32a8090583d7d7c455f1e by Gilles Caulier.
Committed on 11/07/2018 at 19:55.
Pushed by cgilles into branch 'master'.

API doc

D  +0    -1    INSTALL
M  +2    -5    Mainpage.dox
A  +5    -0    README.BUNDLES
M  +8    -2    README.DEVEL
D  +0    -1    README.MACOS
D  +0    -1    README.WINDOWS
D  +0    -1    TODO

https://commits.kde.org/digikam/570c9de1f00ffbf59cd32a8090583d7d7c455f1e

diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index e356264dd8..0000000000
--- a/INSTALL
+++ /dev/null
@@ -1 +0,0 @@
-See README* files for details.
diff --git a/Mainpage.dox b/Mainpage.dox
index 0b9e018fb9..5865aa2c9f 100644
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -26,15 +26,12 @@
 |├── download-repos                                           | Script to \
download all source code including extra repositories         |  |├── gits      \
| Script to perform git in reccursive mode over multiple repositories     |  \
|├── gitup                                                    | Script to \
                perform git pull --rebase in reccursive mode                  |
-|├── INSTALL                                                  | Project \
install notice                                                  |  |├── \
Mainpage.dox                                             | API documentation main \
page based on Doxygen                            |  |├── Messages.sh            \
                | Script to extract strings for translators                           \
                |
-|├── NEWS                                                     | Notice to \
resume all main project changes done at release time          | +|├── NEWS      \
| Notice to resume all project changes done at release time               |  \
|├── README.DEVEL                                             | Read me file \
for developers                                             |  |├── README.md    \
                | First start helper documentation                                    \
                |
-|├── README.MACOS                                             | Read me for \
                MacOs support                                               |
-|├── README.WINDOWS                                           | Read me for \
                Windows support                                             |
-|├── TODO                                                     | List of \
project pending tasks                                           | +|├── \
README.BUNDLES                                           | Read me for Linux, MacOs, \
and Windows bundles support                   |  |├── build                     \
| Directory to store compiled files and binary targets                    |  \
|├── core                                                     | All source code \
are hosted in this directory                            |  |│   ├── app       \
                | Lead application component                                          \
                |
diff --git a/README.BUNDLES b/README.BUNDLES
new file mode 100644
index 0000000000..f72a87ab59
--- /dev/null
+++ b/README.BUNDLES
@@ -0,0 +1,5 @@
+All the bundles information are located in relevant README file from sub-directories \
of project/bundles/: +
+- appimage : bundle for Linux 32 and 64 bits.
+- macports : bundle 64 bits for MacOS.
+- mxe      : bundle for windows 32 and 64 bits.
diff --git a/README.DEVEL b/README.DEVEL
index 075b1377cb..ad6cd9cb4a 100644
--- a/README.DEVEL
+++ b/README.DEVEL
@@ -1,5 +1,11 @@
-See The API documentation to generate with Doxygen.
+See The API documentation to generate with Doxygen. You will find all information \
about the dependencies, +the configuration options, the rules to compile and install, \
and all pointers to contribute to the project as developer.  
-Install Doxygen and Graphviz, and then run make doc from build directory.
+Install Doxygen and Graphviz, and then run make doc from build directory. You can \
also run doxygen command line tool +directly from this folder.
 
 Online version: https://www.digikam.org/api/index.html
+
+For the todo list, see bugzilla for details which is the complete story of the \
project. +
+https://bugs.kde.org/component-report.cgi?product=digikam
diff --git a/README.MACOS b/README.MACOS
deleted file mode 100644
index 8a788b9205..0000000000
--- a/README.MACOS
+++ /dev/null
@@ -1 +0,0 @@
-See ./project/bundles/macports/README
diff --git a/README.WINDOWS b/README.WINDOWS
deleted file mode 100644
index c75078bb67..0000000000
--- a/README.WINDOWS
+++ /dev/null
@@ -1 +0,0 @@
-See ./project/bundles/mxe/README
diff --git a/TODO b/TODO
deleted file mode 100644
index 5838aae256..0000000000
--- a/TODO
+++ /dev/null
@@ -1 +0,0 @@
-See Bugzilla for details.


[prev in list] [next in list] [prev in thread] [next in thread]