Convert to README to .md format
This commit is contained in:
Sam Manzi
parent
43fae0c326
commit
a9401d21d7
167
README.md
167
README.md
@ -1,92 +1,123 @@
|
|||||||
Please read the COPYING file first.
|
Please read the **COPYING** file first.
|
||||||
|
|
||||||
Please read the INSTALL file if you intend to build from source.
|
Please read the **INSTALL** file if you intend to build from source.
|
||||||
|
|
||||||
Requirements
|
Requirements
|
||||||
--------------------------------
|
==========
|
||||||
The following packages *MUST* be installed in order for Gramps to work:
|
The following packages *MUST* be installed in order for Gramps to work:
|
||||||
Python 3.2 or greater
|
|
||||||
GTK 3.10 or greater
|
* Python 3.2 or greater
|
||||||
pygobject 3.12 or greater
|
* GTK 3.10 or greater
|
||||||
cairo, pango, pangocairo with introspection bindings (the gi packages)
|
* pygobject 3.12 or greater
|
||||||
librsvg2 (svg icon view)
|
* cairo, pango, pangocairo with introspection bindings (the gi packages)
|
||||||
xdg-utils
|
* librsvg2 (svg icon view)
|
||||||
bsddb3
|
* xdg-utils
|
||||||
|
* bsddb3
|
||||||
|
|
||||||
The following package is needed for full translation of the interface
|
The following package is needed for full translation of the interface
|
||||||
to your language:
|
to your language:
|
||||||
language-pack-gnome-xx
|
|
||||||
Translation of GTK elements to your language, with
|
* language-pack-gnome-xx
|
||||||
xx your language code; e.g. for Dutch you need
|
|
||||||
language-pack-gnome-nl. The translation of the
|
Translation of GTK elements to your language, with
|
||||||
Gramps strings is included with the gramps source.
|
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:
|
The following packages are **STRONGLY RECOMMENDED** to be installed:
|
||||||
|
--------------------------------------------------------------------
|
||||||
|
* **osmgpsmap**
|
||||||
|
|
||||||
osmgpsmap Used to show maps in the geography view.
|
Used to show maps in the geography view.
|
||||||
It may be osmgpsmap, osm-gps-map, or python-osmgpsmap,
|
It may be osmgpsmap, osm-gps-map, or python-osmgpsmap,
|
||||||
but the Python bindings for this must also be present.
|
but the Python bindings for this must also be present.
|
||||||
Without this the GeoView will not be active, see
|
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
|
https://gramps-project.org/wiki/index.php?title=Gramps_4.2_Wiki_Manual_-_Categories#Geography_Category
|
||||||
|
|
||||||
Graphviz Enable creation of graphs using Graphviz engine.
|
* **Graphviz**
|
||||||
Without this, three reports cannot be run.
|
|
||||||
Obtain it from: http://www.graphviz.org
|
|
||||||
|
|
||||||
PyICU Improves localised sorting in Gramps. In particular, this
|
Enable creation of graphs using Graphviz engine.
|
||||||
applies to sorting in the various views and in the
|
Without this, three reports cannot be run.
|
||||||
Narrative Web output. It is particularly helpful for
|
Obtain it from: http://www.graphviz.org
|
||||||
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
|
* **PyICU**
|
||||||
|
|
||||||
gtkspell Enable spell checking in the notes. Gtkspell depends on
|
Improves localised sorting in Gramps. In particular, this
|
||||||
enchant. A version of gtkspell with gobject introspection
|
applies to sorting in the various views and in the
|
||||||
is needed, so minimally version 3.0.0
|
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/)
|
||||||
|
|
||||||
rcs The GNU Revision Control System (RCS) can be used to manage
|
The following packages are optional:
|
||||||
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
|
* **gtkspell**
|
||||||
Only rcs is needed, NO python bindings are required
|
|
||||||
|
|
||||||
PIL Python Image Library is needed to crop
|
Enable spell checking in the notes. Gtkspell depends on
|
||||||
images and also to convert non-JPG images to
|
enchant. A version of gtkspell with gobject introspection
|
||||||
JPG so as to include them in LaTeX output.
|
is needed, so minimally version 3.0.0
|
||||||
(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
|
* **rcs**
|
||||||
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
|
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
|
||||||
|
|
||||||
goocanvas2 Required for the (user-downloadable) GraphView plugin
|
* **PIL**
|
||||||
|
|
||||||
No longer needed in 4.2:
|
Python Image Library is needed to crop
|
||||||
gir-webkit
|
images and also to convert non-JPG images to
|
||||||
No longer needed in 4.0:
|
JPG so as to include them in LaTeX output.
|
||||||
pygoocanvas, pygtk, pyexiv2
|
(For Python3 a different source may be needed,
|
||||||
No longer needed in 3.3:
|
python-imaging or python-pillow or python3-pillow)
|
||||||
python-enchant Enchant
|
|
||||||
No longer needed in 3.2:
|
* **GExiv2**
|
||||||
python glade bindings
|
|
||||||
No longer needed in 3.1:
|
Enables Gramps to manage Exif metadata embedded in your
|
||||||
yelp Gnome help browser. No offline help is shipped see Gramps website for User manual
|
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
|
||||||
|
|
||||||
|
* **goocanvas2**
|
||||||
|
|
||||||
|
Required for the (user-downloadable) GraphView plugin
|
||||||
|
|
||||||
|
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
|
Documentation
|
||||||
---------------------------------
|
-------------
|
||||||
The User Manual is maintained on the Gramps website,
|
The User Manual is maintained on the Gramps website:
|
||||||
http://www.gramps-project.org/wiki/index.php?title=User_manual
|
|
||||||
|
* https://www.gramps-project.org/wiki/index.php?title=User_manual
|
||||||
|
|
||||||
|
|
||||||
|
The Gramps Project ( https://gramps-project.org )
|
||||||
|
-------------------------------------------------
|
||||||
|
We strive to produce a genealogy program that is both intuitive for hobbyists and feature-complete for professional genealogists.
|
||||||
|
|
||||||
|
|
||||||
--------------------------------
|
|
||||||
The Gramps Project
|
|
||||||
http://gramps-project.org
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user