Doxygen files.

[gedcom-parse.git] / README

diff --git a/README b/README
index d2dbe71370093ba00c281532c9cace2ed39d233d..84a7d7bc5e0d2a3076275067ef5b901d967b001a 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,8 @@
 The Gedcom parser library (release @VERSION@)
 -------------------------
 The Gedcom parser library is a C library that provides an API to applications
-to parse and process arbitrary genealogy files in the standard gedcom format.
+to parse, process and write arbitrary genealogy files in the standard gedcom
+format.
 
 Its main features are:
 
@@ -23,18 +24,24 @@ Its main features are:
  - internationalization of the error and warning messages
 
  - specific parsing of date values to a calendar-neutral date system (Julian
-   days aka serial day numbers); the date parser can be called separately
+   days aka serial day numbers); the date parser can be called separately and
+   dates can be manipulated
 
  - specific parsing and checking of cross-references
 
  - specific parsing of age values
 
- - support for writing Gedcom files
+ - support for writing Gedcom files (both in line-by-line format, or via the
+   Gedcom object model)
 
  - "compatibility-mode" parsing, to allow for not-exactly-standard syntaxes
-   used by other genealogy programs; currently, compatibility is added for:
+   used by other genealogy programs; currently, compatibility is added for
+   (not necessarily complete):
      - ftree
-     - Lifelines 3.0.2 (not complete)
+     - Lifelines 3.0.2
+     - Personal Ancestral File (PAF), version 2, 4 and 5
+     - Family Origins
+     - EasyTree
 
 NOTE:
  - NO BACKWARD COMPATIBILITY is guaranteed for 0.x releases !
@@ -43,7 +50,6 @@ To do list:
  - specific parsing of other special values
  - compatibility with other genealogy programs
  - older/newer Gedcom standards ?
- - modifying data
  - writing GEDML files
  - C++ object model
  - ...
@@ -92,6 +98,11 @@ This is simply:
   make
   make install
 
+If libiconv is not automatically found, you can give its path to configure,
+for example, if the library lives in /home/mydir/lib:
+
+  ./configure --with-libiconv-prefix=/home/mydir
+
 You can also run some tests via:
   make check