Source code for Gramps Genealogical program
Go to file
2013-10-07 22:03:12 +00:00
data 7110: Add AppData file 2013-10-07 09:38:29 +00:00
debian .deb package more compliant according to Debian policy 2013-07-29 16:28:34 +00:00
docs 6028: gen module should be gramps.gen 2013-09-13 10:46:43 +00:00
example add some more names to data.gramps (more modern: divorces, etc.) 2013-06-03 20:17:24 +00:00
gramps Freeze headings when scrolling 2013-10-07 22:03:12 +00:00
help
images [r22576]Move the HTML resources from gramps/plugins/webstuff 2013-06-23 23:13:13 +00:00
mac Update for Gramps-4.0.1 2013-06-24 18:14:11 +00:00
po 7110: Add AppData file 2013-10-07 09:38:29 +00:00
scripts 6283: Re-enable optimization flag (-O) for python 2013-02-25 07:26:36 +00:00
test 7016: new cmdline switches -y/--yes and -q/--quiet 2013-08-29 12:41:31 +00:00
windows Start convertion to introspection. Flat models work, as does relationship view 2012-06-17 21:25:37 +00:00
.gitignore Added tags file 2013-08-06 22:25:52 +00:00
AUTHORS
COPYING
FAQ
Gramps.py [r21613]Determine Paths at Runtime 2013-03-11 22:54:20 +00:00
INSTALL slight tweaks to text, add text property 2013-03-09 17:48:00 +00:00
LICENSE Moved GPLv2 License file up front for easier location and reading. Every project that I have seen has it in the main root directory. 2012-06-09 01:35:37 +00:00
MANIFEST.in need const.py into source tarball 2013-04-06 09:40:49 +00:00
NEWS ready for 4.0.1 2013-06-24 09:10:05 +00:00
README clarify and qualify release information 2013-04-06 16:56:57 +00:00
RELEASE_NOTES road to 4.0.0 2013-05-21 09:15:43 +00:00
setup.py 7110: Add AppData file 2013-10-07 08:21:57 +00:00
TestPlan.txt
TODO replace with a link to GEPS page 2012-10-27 13:51:56 +00:00

$Id$

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.7 or greater, Python 3.2 or greater (or both python versions)
   GTK 3.0 or greater
   pygobject 3.3.2 or greater
   cairo, pango, pangocairo with introspection bindings (the gi packages)
   librsvg2 (svg icon view)
   xdg-utils
   bsddb3 is required for Python 3.2 (not python 2.7)

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; e.g. for Dutch you need
                    language-pack-gnome-nl. The translation of the
                    Gramps strings is included with the gramps source.


The following packages are *STRONGLY RECOMMENDED* to be installed:

   osmgpsmap        Used to show maps in the geography view. 
                    It may be osmgpsmap, osm-gps-map, or python-osmgpsmap,
                    but the Python bindings for this must also be present.
                    Without this the GeoView will not be active, see
                    http://gramps-project.org/wiki/index.php?title=Gramps_4.0_Wiki_Manual_-_Main_Window#Geography_Category
                    !! PACKAGERS: unfortunately, at the moment (March 2013),
                    the patches which gramps 4.0 needs osm-gps-map to have
                    are not yet released (as a new osm-gps-map version). The
                    osm-gps-map sources must be dated 6 February 2013 (or
                    later) to have the necessary patches.  You may obtain
                    it from: http://nzjrs.github.com/osm-gps-map/ or else
                    http://sourceforge.net/projects/gramps/files/Dependencies
                    (The necessary version seems to be 0.8 -- or later.)

   GraphViz         Enable creation of graphs using GraphViz engine.
                    Without this, three reports cannot be run.
                    Obtain it from: http://www.graphviz.org

   PyICU            Improves localised sorting in Gramps. In particular, this
                    applies to sorting in the various views and in the
                    Narrative Web output. It is particularly helpful for
                    non-Latin characters, for non-English locales and on MS
                    Windows and Mac OS X platforms. If it is not available,
                    sorting is done through built-in libraries. PyICU is
                    fairly widely available through the package managers of
                    distributions. See http://pyicu.osafoundation.org/
                    (These are Python bindings for the ICU package.)

The following packages are optional

   gtkspell         Enable spell checking in the notes. Gtkspell depends on 
                    enchant. A version of gtkspell with gobject introspection
                    is needed, so minimally version 3.0.0

   rcs              The GNU Revision Control System (RCS) can be used to manage
                    multiple revisions of your family trees. See info at
                    http://www.gramps-project.org/wiki/index.php?title=Gramps_4.0_Wiki_Manual_-_Manage_Family_Trees#Archiving_a_Family_Tree
                    Only rcs is needed, NO python bindings are required

   PIL              Python Image Library is needed to crop
                    images and also to convert non-JPG images to
                    JPG so as to include them in LaTeX output.
                    (For Python3 a different source may be needed.)

   GExiv2           Enables Gramps to manage Exif metadata embedded in your
                    media. Gramps needs version 0.5 or greater.
                    See http://www.gramps-project.org/wiki/index.php?title=GEPS_029:_GTK3-GObject_introspection_Conversion#GExiv2_for_Image_metadata

   ttf-freefont     More font support in the reports

   gir-webkit       GObject introspection data of WebKit is required for the
                    hidden view 'Htmlview', which 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:
                       from gi.repository import WebKit as webkit

   goocanvas2:
                    Required for the (user-downloadable) Graphview plugin

No longer needed in 4.0:
   pygoocanvas, pygtk, pyexiv2
No longer needed in 3.3:
   python-enchant Enchant
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

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