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 and process arbitrary genealogy files in the standard gedcom format.
   5
   6 Its main features are:
   7
   8  - strict callback-based parser written in C (using lex/yacc), a C object
   9    model is also available (compare to the difference between SAX and DOM
  10    in XML).
  11
  12  - supports the Gedcom 5.5 standard fully
  13
  14  - supports the standard encoding formats (ASCII, ANSEL, UNICODE), but
  15    extensible (via a configuration file) to other encoding formats; by
  16    default ANSI is also supported.
  17
  18  - all strings passed from callbacks to the using program are in UTF-8 format
  19
  20  - internationalization of the error and warning messages
  21
  22  - specific parsing of date values to a calendar-neutral date system (Julian
  23    days aka serial day numbers); the date parser can be called separately
  24
  25  - specific parsing and checking of cross-references
  26
  27  - specific parsing of age values
  28
  29  - "compatibility-mode" parsing, to allow for not-exactly-standard syntaxes
  30    used by other genealogy programs; currently, compatibility is added for:
  31      - ftree
  32      - Lifelines 3.0.2 (not complete)
  33
  34 NOTE:
  35  - NO BACKWARD COMPATIBILITY is guaranteed for 0.x releases !
  36
  37 To do list:
  38  - specific parsing of other special values
  39  - compatibility with other genealogy programs
  40  - older/newer Gedcom standards ?
  41  - modifying data
  42  - writing GEDCOM files, GEDML files
  43  - C++ object model
  44  - ...
  45
  46 For more information, refer to the documentation in the doc subdirectory,
  47 or to the SourceForge project web site and summary page:
  48   http://gedcom-parse.sourceforge.net
  49   http://sourceforge.net/projects/gedcom-parse
  50
  51 Also, have a look at the 'Genes' program, from which this library is a
  52 spin-off, and which uses this library:
  53   http://genes.sourceforge.net
  54   http://sourceforge.net/projects/genes
  55
  56
  57 Requirements:
  58 ------------
  59  - glibc 2.2 or higher
  60
  61 To build from sources, you'll also need:
  62  - gcc
  63  - autoconf
  64  - automake
  65  - flex
  66  - bison (won't work with plain yacc)
  67
  68 It is possible that it also runs on other platforms than Linux (and that the
  69 glibc version requirement can be loosened), however, I can only support Linux
  70 because that is the only platform I have...
  71
  72
  73 Installation:
  74 ------------
  75 This is simply:
  76
  77   ./configure
  78   make
  79   make install
  80
  81 You can also run some tests via:
  82   make check
  83
  84
  85 ###############################################################################
  86 # $Id$
  87 # $Name$