aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Vrátil <dvratil@kde.org>2016-08-05 00:53:51 (GMT)
committerDaniel Vrátil <dvratil@kde.org>2016-08-05 00:53:51 (GMT)
commitaf762b9230dda02adc2995f807718f3b2687eeea (patch)
tree7155468060d62f01a70e592e325d27cd70415a4d
parent078240679ae27508f5a2bccad5c6dae4d33ef41b (diff)
Enable docs generation on api.kde.org
-rw-r--r--Mainpage.dox1
-rw-r--r--README.md9
-rw-r--r--metainfo.yaml8
3 files changed, 15 insertions, 3 deletions
diff --git a/Mainpage.dox b/Mainpage.dox
deleted file mode 100644
index 57b7f27..0000000
--- a/Mainpage.dox
+++ /dev/null
@@ -1 +0,0 @@
-// DOXYGEN_REFERENCES = kdecore kdeui kio
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cccf674
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+# Akonadi Mime
+
+Akonadi Mime is a library that effectively bridges the type-agnostic API of
+the Akonadi client libraries and the domain-specific KMime library. It provides
+jobs, models and other helpers to make working with emails through Akonadi easier.
+
+The most notable classes are "commands" to update email flags (like read, spam,
+etc.) or move it to trash and Akonadi::StandardMailActionManager which provides
+set of email-specific QActions.
diff --git a/metainfo.yaml b/metainfo.yaml
index f342a89..b1e8541 100644
--- a/metainfo.yaml
+++ b/metainfo.yaml
@@ -1,5 +1,5 @@
-maintainer:
-description: Akonadi-Mime library
+maintainer: dvratil
+description: Akonadi Mime library
tier: 3
type: functional
platforms:
@@ -12,3 +12,7 @@ libraries:
cmake: "KF5::AkonadiMime"
cmakename: KF5AkonadiMime
+public_lib: true
+group: kdepim
+platforms:
+ - name: Linux