Source code for Gramps Genealogical program
Go to file
Doug Blank a2f40fbf67 Bash completetions: a little cleaning up 2016-05-06 16:02:09 -04:00
bash Bash completetions: a little cleaning up 2016-05-06 16:02:09 -04:00
data typo 2016-05-03 11:38:27 +02:00
debian GRAMPS > Gramps 2015-08-29 11:23:07 +10:00
docs 7335: Cleanup code, filenames, and documentation 2016-01-23 14:22:41 -05:00
example Tests: don't make home person the private person 2016-04-19 07:16:58 -04:00
gramps Where: work with methods, ala Rules 2016-05-06 10:04:24 -04:00
help Update COPYING-DOCS 2015-04-03 13:20:27 +11:00
images Remove executable permission from png files 2015-06-18 13:42:13 +01:00
mac Bug 8563: Gramps reports that it can't find dictionaries. 2016-04-16 15:08:24 -07:00
po update German translation 2016-05-05 21:48:50 +02:00
scripts 6283: test flag for python on new script, not on Gramps.py... (thank you Paul) 2013-02-25 07:24:40 +00:00
test Update FSF address to current location. 2014-08-08 19:39:45 -07:00
windows add Windows Python header files for 32-bit and 64-bit machines 2016-03-20 23:04:23 -07:00
.gitattributes Make Github recognise Gramps as a Python project 2015-07-14 10:19:04 +10:00
.gitignore 7921 Move holidays.xml.in to data [refactor] 2016-04-16 16:38:43 +10:00
.mailmap remove my personal email address from .mailcap file 2016-04-09 09:29:17 -07:00
.pylintrc Add .pylintrc file 2016-01-10 16:41:44 +00:00
.travis.yml Remove Django-style WHERE; consider Python expressions 2016-04-17 16:54:55 -04:00
AUTHORS Add myself (jralls) to AUTHORS per request from Rob Healey 2012-06-05 04:27:12 +00:00
COPYING 6918: http://lintian.debian.org/tags/old-fsf-address-in-copyright-file.html 2013-11-07 11:26:57 -08:00
FAQ 7553 Change GraphViz to Graphviz 2015-07-19 14:24:33 +10:00
Gramps.py Move GRAMPS_RESOURCE default into grampsapp.main() 2016-04-14 20:58:27 -04:00
INSTALL 8047 - Update INSTALL file to document --resourcepath option 2015-06-15 22:35:32 +02:00
LICENSE 6918: http://lintian.debian.org/tags/old-fsf-address-in-copyright-file.html 2013-11-07 11:26:57 -08:00
MANIFEST.in Moved guiQML to its own project 2016-04-17 13:01:47 -04:00
NEWS 7553 Change GraphViz to Graphviz 2015-07-19 14:24:33 +10:00
README.md Added codecov patch 2016-02-13 15:54:09 -05:00
RELEASE_NOTES clarify and qualify release information 2013-04-06 16:57:29 +00:00
TODO replace with a link to GEPS page 2012-10-27 13:51:56 +00:00
TestPlan.txt add test for reports 2004-10-10 19:02:58 +00:00
setup.py 7921 Move holidays.xml.in to data [refactor] 2016-04-16 16:38:43 +10:00

README.md

The Gramps Project ( https://gramps-project.org ) Build Statuscodecov.io

We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists.

Please read the COPYING file first.

Please read the INSTALL file if you intend to build from source.

Requirements

The following packages MUST be installed in order for Gramps to work:

The following three packages with GObject Introspection bindings (the gi packages)

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.

  • 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 https://gramps-project.org/wiki/index.php?title=Gramps_4.2_Wiki_Manual_-_Categories#Geography_Category

  • 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. https://pypi.python.org/pypi/PyICU/)

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 https://gramps-project.org/wiki/index.php?title=Gramps_4.2_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, python-imaging or python-pillow or python3-pillow)

  • GExiv2

Enables Gramps to manage Exif metadata embedded in your media. Gramps needs version 0.5 or greater. See https://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

Optional packages required by Third-party Addons

Third-party Addons are written by users and developers and unless stated are not officially part of Gramps. For more information about Addons see: https://gramps-project.org/wiki/index.php?title=Third-party_Plugins

Prerequistes required for the following Addons to work:

No longer needed:

  • Since Gramps 4.2: gir-webkit

  • Since Gramps 4.0: pygoocanvas, pygtk, pyexiv2

  • Since Gramps 3.3: python-enchant Enchant

  • Since Gramps 3.2: python glade bindings

  • Since Gramps 3.1: yelp - Gnome help browser. No offline help is shipped see Gramps website for User manual

Documentation

The User Manual is maintained on the Gramps website: