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