README

   1 The Gedcom parser library (release @VERSION@)
   2 -------------------------
   3 The Gedcom parser library is a C library that provides an API to applications
   4 to parse, process and write arbitrary genealogy files in the standard gedcom
   5 format.
   6
   7 Its main features are:
   8
   9  - portable to any POSIX systems (libiconv is needed on systems that lack
  10    glibc 2.2, see below)
  11
  12  - strict callback-based parser written in C (using lex/yacc), a C object
  13    model is also available (compare to the difference between SAX and DOM
  14    in XML).
  15
  16  - supports the Gedcom 5.5 standard fully
  17
  18  - supports the standard encoding formats (ASCII, ANSEL, UNICODE), but
  19    extensible (via a configuration file) to other encoding formats; by
  20    default ANSI is also supported.
  21
  22  - all strings passed from callbacks to the using program are in UTF-8 format
  23
  24  - internationalization of the error and warning messages
  25
  26  - specific parsing of date values to a calendar-neutral date system (Julian
  27    days aka serial day numbers); the date parser can be called separately and
  28    dates can be manipulated
  29
  30  - specific parsing and checking of cross-references
  31
  32  - specific parsing of age values
  33
  34  - support for writing Gedcom files (both in line-by-line format, or via the
  35    Gedcom object model)
  36
  37  - "compatibility-mode" parsing, to allow for not-exactly-standard syntaxes
  38    used by other genealogy programs; currently, compatibility is added for:
  39      - ftree
  40      - Lifelines 3.0.2 (not complete)
  41
  42 NOTE:
  43  - NO BACKWARD COMPATIBILITY is guaranteed for 0.x releases !
  44
  45 To do list:
  46  - specific parsing of other special values
  47  - compatibility with other genealogy programs
  48  - older/newer Gedcom standards ?
  49  - modifying data
  50  - writing GEDML files
  51  - C++ object model
  52  - ...
  53
  54 For more information, refer to the documentation in the doc subdirectory,
  55 or to the SourceForge project web site and summary page:
  56   http://gedcom-parse.sourceforge.net
  57   http://sourceforge.net/projects/gedcom-parse
  58
  59 Also, have a look at the 'Genes' program, from which this library is a
  60 spin-off, and which uses this library:
  61   http://genes.sourceforge.net
  62   http://sourceforge.net/projects/genes
  63
  64
  65 Requirements:
  66 ------------
  67 For using the library:
  68  - either glibc 2.2 or higher, or libiconv
  69
  70 Note:
  71
  72   The official libiconv package doesn't have ANSEL support, and is not
  73   extensible except by modifying its source code.
  74
  75   There is a modified libiconv package available on the SourceForge project
  76   page, which is called 'libiconv-gedcom-1.8.x', based on libiconv 1.8.
  77   Install this if you need ANSEL support and you don't have glibc 2.2.
  78
  79 To compile the package, you'll need:
  80  - gcc
  81
  82 To compile from the CVS sources, you'll need in addition:
  83  - autoconf
  84  - automake
  85  - flex
  86  - bison (won't work with plain yacc)
  87  - perl
  88
  89
  90 Installation:
  91 ------------
  92 This is simply:
  93
  94   ./configure
  95   make
  96   make install
  97
  98 If libiconv is not automatically found, you can give its path to configure,
  99 for example, if the library lives in /home/mydir/lib:
 100
 101   ./configure --with-libiconv-prefix=/home/mydir
 102
 103 You can also run some tests via:
 104   make check
 105
 106
 107 ###############################################################################
 108 # $Id$
 109 # $Name$