improve USAGE section
authorHans Ulrich Niedermann <hun@n-dimensional.de>
Wed, 23 May 2007 12:25:08 +0000 (14:25 +0200)
committerHans Ulrich Niedermann <hun@n-dimensional.de>
Wed, 23 May 2007 12:25:08 +0000 (14:25 +0200)
README

diff --git a/README b/README
index 15f192a..12b40fd 100644 (file)
--- a/README
+++ b/README
@@ -8,6 +8,7 @@ libexif is a library for parsing, editing, and saving EXIF data. It is
 intended to replace lots of redundant implementations in command-line
 utilities and programs with GUIs.
 
+
 FEATURES
 --------
 
@@ -15,11 +16,13 @@ libexif supports parsing, editing and saving of EXIF data. In addition, it
 has gettext support. All EXIF tags described in EXIF standard 2.1
 are supported.
 
+
 REQUIREMENTS
 ------------
 
 libexif is written in plain C and does not require any additional library.
 
+
 LIMITATIONS
 -----------
 
@@ -27,16 +30,28 @@ libexif can only handle some maker notes, and even those not very well. More
 work needs to be done. Note that libmnote has been merged with libexif - it
 is no longer needed.
 
+
 USAGE
 -----
 
-Until someone writes some documentation, you need to refer to the header 
-files. The short test-program test/test-mem illustrates how to create valid
+We have started documenting the libexif API using doxygen and are making
+the results available at http://libexif.sourceforge.net/api/
+
+Until someone writes some better documentation however, you need to refer
+to the header files.
+
+The short test-program test/test-mem illustrates how to create valid
 EXIF data from scratch, how to save EXIF data and how to load EXIF data 
 from data in memory. Don't hesitate to contact us 
 (<libexif-devel@lists.sourceforge.net>) if you've got any questions
 on how to use libexif.
 
+To link to libexif into your own package, we recommend using the
+pkgconfig utility (cf. http://pkg-config.freedesktop.org/wiki/). For
+your convenience, libexif both provides libexif-uninstalled.pc and
+installs libexif.pc.
+
+
 FRONTENDS
 ---------
 
@@ -54,12 +69,14 @@ Right now, I know of the following frontends to libexif:
 If you would like to migrate your program to use libexif or add EXIF support
 to it, don't hesitate to contact the authors.
 
+
 LIBRARIES
 ---------
 
 I know of the following libraries that use or have been inspired by libexif:
  - pel: PHP-Code (http://pel.sourceforge.net)
 
+
 AUTHORS
 -------
 
@@ -68,6 +85,7 @@ libexif has originally been written by Curtis Galloway
 supporting editing and saving, Lutz Müller <lutz@users.sourceforge.net>
 rewrote libexif from scratch.
 
+
 LINKS
 -----