gramps/README
2010-02-05 20:17:39 +00:00

69 lines
2.8 KiB
Plaintext

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 packages are *STRONGLY RECOMMENDED* to be installed:
GraphViz Enable creation of graphs using GraphViz engine
http://www.graphviz.org
The following packages are *STRONGLY RECOMMENDED* to be installed:
PyWebKitGtk or python-gtkmozembed: PACKAGERS, Test if on your distribution
webkit and Gramps is stable. If you get 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 Geographic view and Web view
Often called python-webkit package.
Be careful, webkit is always in a development phase.
* python-gtkmozembed
Enable html rendering for Geographic view and Web view
The gecko (firefox) equivalent to webkit, at the moment
of writing, more stable than webkit.
It can be in python-gnome2-extras or python-gtkhtml2
depending on distributions.
The following packages are optional
python gtkspell & python enchant : Enable spell checking in the notes,
the first contains the libraries, the second is
needed to query the installed languages. Both must
be present for spell check to activate
ttf-freefont More font support in the reports
No longer needed in 3.1:
yelp Gnome help browser. At the moment no help is shipped
No longer needed in 3.2:
python glade bindings
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
--------------------------------
Donald Allingham
dallingham@users.sourceforge.net
benny.malengier@gramps-project.org