[devhelp] readme: add references to other documentation
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devhelp] readme: add references to other documentation
- Date: Thu, 19 Dec 2019 17:08:08 +0000 (UTC)
commit 9f769ba5bac87ea79d85226e66328f438c2259c4
Author: Sébastien Wilmet <swilmet gnome org>
Date: Thu Dec 19 18:06:44 2019 +0100
readme: add references to other documentation
README | 14 ++++++++------
1 file changed, 8 insertions(+), 6 deletions(-)
---
diff --git a/README b/README
index 9dab6337..8d7b12fb 100644
--- a/README
+++ b/README
@@ -58,10 +58,12 @@ For the --search command line option, see the class description of
DhKeywordModel, the search string supports additional features useful for IDEs
or other developer tools.
-Misc notes
-----------
+Other documentation
+-------------------
-The first version of the index file format (with the *.devhelp file
-extension) is deprecated and its support will probably be removed in a
-future version. You should use the second version, with the *.devhelp2
-file extension.
+- There is user documentation written in the Mallard format in the `help/C/`
+ directory. You can open that documentation with the `yelp help/C/` command,
+ or pressing F1 in the Devhelp application.
+
+- There is an API reference manual for the libdevhelp that can be built with
+ GTK-Doc, see the `gtk_doc` build option.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]