Please read the COPYING file first.
If building from source, also read the INSTALL file (at least through the
"SUPER-SHORT VERSION") before going further.

Requirements
--------------------------------
The following packages *MUST* be installed in order for Gramps to work:
   Python 2.5 or greater
   PyGTK2 2.12 or greater
   librsvg2 (svg icon view)
   xdg-utils

The following package is needed for full translation of the interface
to your language:
   language-pack-gnome-xx 
                    Translation of GTK elements to your language, with             
                    xx your language code eg for Dutch you need
                    language-pack-gnome-nl. The translation of the
                    Gramps strings is included with the source code.


The following packages are *STRONGLY RECOMMENDED* to be installed:
   osmgpsmap        Used to show maps in the geography view. 
                    Without this the GeoView will not be active, see
                    http://gramps-project.org/wiki/index.php?title=Gramps_3.3_Wiki_Manual_-_Main_Window#Geography_Category
                    The package is named osmgpsmap, osm-gps-map
                    or python-osmgpsmap. Or obtain it from: http://nzjrs.github.com/osm-gps-map/
   GraphViz         Enable creation of graphs using GraphViz engine.
                    Without this no beautiful graphs can be created.
                    Obtain it from: http://www.graphviz.org
   pyexiv2          Enables Gramps to manage Exif metadata embedded in your
                    media. Gramps needs version 0.1.3 or greater.
                    Obtain it from: http://tilloy.net/dev/pyexiv2/download.html  

The following packages are optional
   ImageMagick      Enables addon 'Edit Image Exif Metadata' :
                        * Convert Image file types...
                        * Stripping of Exif Metadata from image...

  ImageMagick may be downloaded from here: 
      * http://www.imagemagick.org

  Jhead             Enables 'Edit Image Exif Metadata' :
                        * Stripping of Exif metadata...
                        * Re- initializing of Jpeg image files...

  Jhead may be downloaded from here:
      * http://www.sentex.net/~mwandel/jhead

   python gtkspell  Enable spell checking in the notes, gtkspell contains the
                    libraries.
   pyenchant        This must be installed in Windows. It includes enchant and
                    some dictionaries. You must add a dictionary for your own
                    language. For more info see the Wiki:
                    http://www.gramps-project.org/wiki/index.php?title=Windows_installer#Installation

   ttf-freefont     More font support in the reports

   PyWebKitGtk or python-gtkmozembed: 
                    The hidden view 'Htmlview' allows websites to be opened in
                    Gramps. Users can unhide the view in the plugin manager. 
                    A html renderer must be installed to use the view.
                    !! PACKAGERS, Test if on your distribution
                    webkit and Gramps is stable. If you obtain crashes, patch 
                    src/plugins/view/htmlrenderer.py and
                    src/plugins/view/geoview.gpr.py, so as to remove:
                       import webkit
                    Then use the gecko package (python-gtkmozembed) instead.
                    If WEBKIT ang GECKO are installed, webkit will be used as
                    the javascript engine is faster (google maps).
                  * PyWebKitGtk    
                    Enable html rendering for the Web view. Often called 
                    python-webkit package. Be careful, webkit is always in a 
                    development phase.
                  * python-gtkmozembed 
                    Enable html rendering for the Web view in case PyWebKitGtk
                    is not available or to be used if webkit is unstable.
                    It can be in python-gnome2-extras or python-gtkhtml2
                    depending on distributions.

No longer needed in 3.3:
   python-enchant Enchant for Linux and Mac. Still needed for Windows.
No longer needed in 3.2:
   python glade bindings
No longer needed in 3.1:
   yelp             Gnome help browser. At the moment no help is shipped

Documentation
---------------------------------
The User Manual is now maintained on the gramps website,
http://www.gramps-project.org/wiki/index.php?title=User_manual
We might in the future distribute again a manual via gnome-doc-utils, this has not
been decided yet though.


Building on non-Linux systems: i18n support and GNU make
--------------------------------------------------------
If make fails, use gmake (the name FreeBSD gives to GNU make) instead.
You might need a patch also. FreeBSD has in ports a patch (  /usr/ports/science/gramps/files)
you need to apply to po/Makefile.in.in 


--------------------------------
The Gramps Project
http://gramps-project.org