Skip to content

Commit

Permalink
Tidy up the README file
Browse files Browse the repository at this point in the history
  • Loading branch information
@Nick-Hall
Nick-Hall committed Mar 22, 2024
1 parent 506a638 commit 90dde2c
Showing 1 changed file with 51 additions and 61 deletions.
112 changes: 51 additions & 61 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,33 +1,32 @@
The Gramps Project ( https://gramps-project.org )
[The Gramps Project](https://gramps-project.org)
===================
[![GitHub CI](https://github.com/gramps-project/gramps/actions/workflows/gramps-ci.yml/badge.svg?event=push&branch=master)](https://github.com/gramps-project/gramps/actions/workflows/gramps-ci.yml?query=branch%3Amaster)
[![codecov.io](https://codecov.io/github/gramps-project/gramps/coverage.svg?branch=master)](https://app.codecov.io/gh/gramps-project/gramps/branch/master)
[![GitHub CI](https://github.com/gramps-project/gramps/actions/workflows/gramps-ci.yml/badge.svg?event=push&branch=maintenance/gramps52)](https://github.com/gramps-project/gramps/actions/workflows/gramps-ci.yml?query=branch%3Amaintenance/gramps52)
[![codecov.io](https://codecov.io/github/gramps-project/gramps/coverage.svg?branch=maintenance/gramps52)](https://app.codecov.io/gh/gramps-project/gramps/branch/maintenance/gramps52)
[![Translation status](https://hosted.weblate.org/widgets/gramps-project/-/gramps/svg-badge.svg)](https://hosted.weblate.org/engage/gramps-project)

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 [**COPYING**](https://github.com/gramps-project/gramps/blob/maintenance/gramps52/COPYING) file first.

Please read the **INSTALL** file if you intend to build from source.
Please read the [**INSTALL**](https://github.com/gramps-project/gramps/blob/maintenance/gramps52/INSTALL) file if you intend to build from source.

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

* **Python** 3.8 or greater - The programming language used by Gramps. https://www.python.org/
* **GTK** 3.24 or greater - A cross-platform widget toolkit for creating graphical user interfaces. http://www.gtk.org/
* **pygobject** 3.12 or greater - Python Bindings for GLib/GObject/GIO/GTK+ https://wiki.gnome.org/Projects/PyGObject
* [**Python**](https://www.python.org/) 3.8 or greater - The programming language used by Gramps.
* [**GTK**](http://www.gtk.org/) 3.24 or greater - A cross-platform widget toolkit for creating graphical user interfaces.
* [**pygobject**](https://wiki.gnome.org/Projects/PyGObject) 3.12 or greater - Python Bindings for GLib/GObject/GIO/GTK+

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

* **cairo** 1.14.0 or greater - a 2D graphics library with support for multiple output devices. http://cairographics.org/
* **Pycairo** 1.13.3 or greater - GObject Introspection bindings for cairo. https://github.com/pygobject/pycairo
* **pango** - a library for laying out and rendering of text, with an emphasis on internationalization. http://www.pango.org/
* **pangocairo** - Allows you to use Pango with Cairo http://www.pango.org/

* **librsvg2** - (SVG icon view) a library to render SVG files using cairo. http://live.gnome.org/LibRsvg
* **bsddb3** - Python bindings for Oracle Berkeley DB https://pypi.python.org/pypi/bsddb3/
* **sqlite3** - Python bindings for SQLite Database library
* [**cairo**](http://cairographics.org/) 1.14.0 or greater - a 2D graphics library with support for multiple output devices.
* [**Pycairo**](https://github.com/pygobject/pycairo) 1.13.3 or greater - GObject Introspection bindings for cairo.
* [**pango**](http://www.pango.org/) - a library for laying out and rendering of text, with an emphasis on internationalization.
* [**pangocairo**](http://www.pango.org/) - Allows you to use Pango with Cairo.
* [**librsvg2**](http://live.gnome.org/LibRsvg) - (SVG icon view) a library to render SVG files using cairo.
* [**bsddb3**](https://pypi.python.org/pypi/bsddb3/) - Python bindings for Oracle Berkeley database.
* [**sqlite3**](https://www.sqlite.org/) - Python bindings for SQLite Database library.

The following package is needed for full translation of the interface
to your language:
Expand All @@ -42,21 +41,20 @@ to your language:

The following packages are **STRONGLY RECOMMENDED** to be installed:
--------------------------------------------------------------------
* **osmgpsmap**
* [**osmgpsmap**](https://nzjrs.github.io/osm-gps-map/)

Used to show maps in the geography view.
Used to show maps in the [Geography Category](https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Categories#Geography_Category).
It may be osmgpsmap, osm-gps-map, or python-osmgpsmap,
but the Python bindings for this must also be present, so gir1.2-osmgpsmap-1.0.
Without this the GeoView will not be active, see
https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Categories#Geography_Category
Without this the GeoView will not be active.

* **Graphviz**
* [**Graphviz**](http://www.graphviz.org)

Enable creation of graphs using Graphviz engine.
Without this, three reports cannot be run.
Obtain it from: http://www.graphviz.org or try graphviz and python3-pygraphviz from your packages.
The package name is usually graphviz or python3-pygraphviz.

* **PyICU**
* [**PyICU**](http://pyicu.osafoundation.org/)

Improves localised sorting in Gramps. In particular, this
applies to sorting in the various views and in the
Expand All @@ -65,86 +63,76 @@ The following packages are **STRONGLY RECOMMENDED** to be installed:
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/
distributions.
(These are Python bindings for the ICU package
https://pypi.python.org/pypi/PyICU/).

* **Ghostscript**
* [**Ghostscript**](https://www.ghostscript.com)

Used by Graphviz reports to help create PDF files.

* **python-imagesize**
* [**python-imagesize**](https://pypi.org/project/imagesize/)

Provides better image processing performance. If this module is not available,
we continue to use Gdk. This provides a real improvement when we need to
process many big images.


The following packages are optional:
------------------------------------
* **gspell**

Enable spell checking in the notes.

* **rcs**
* [**rcs**](https://www.gnu.org/software/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_5.1_Wiki_Manual_-_Manage_Family_Trees#Archiving_a_Family_Tree
The GNU Revision Control System (RCS) can be used to
[archive a family tree](https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees#Archiving_a_Family_Tree).
Multiple revisions of your family trees can be managed.
Only rcs is needed, NO python bindings are required.

* **Pillow**
* [**Pillow**](https://python-pillow.org)

The friendly Python Image Library fork is needed to crop
images and also to convert non-JPG images to
JPG so as to include them in LaTeX output.
The package name is usually python-pillow or python3-pillow.

* **GExiv2**
* [**gexiv2**](https://wiki.gnome.org/Projects/gexiv2) 0.5 or greater

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
media.

* **ttf-freefont**
* [**ttf-freefont**](https://savannah.gnu.org/projects/freefont/)

Provides genealogical symbols and more fonts for reports

* **geocodeglib**
* **geocode-glib**

A library use to associate a geographical position (latitude, longitude)
to a place name. This is used if you already have osmgpsmap installed.
If installed, when you add or link a place from the map, you have a red line
at the end of the table for selection.
Debian, Ubuntu, ... : gir1.2-geocodeglib-1.0
Fedora, Redhat, ... : geocode-glib
openSUSE : geocode-glib
ArchLinux : geocode-glib
...
The package name is usually gir1.2-geocodeglib-1.0 or geocode-glib.

* **fontconfig**
* [**fontconfig**](https://www.freedesktop.org/wiki/Software/fontconfig/)

Python bindings of fontconfig are required for displaying
genealogical symbols


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
**[Third-party Addons](https://gramps-project.org/wiki/index.php?title=Third-party_Plugins) are written by users and developers and unless stated are not officially part of Gramps.**

Prerequistes required for the following Addons to work:

* **Family Sheet** - Requires: Pillow
( https://gramps-project.org/wiki/index.php?title=Family_Sheet )

* **Graph View** - Requires: PyGoocanvas and Goocanvas (python-pygoocanvas, gir1.2-goocanvas-2.0).
( https://gramps-project.org/wiki/index.php?title=Graph_View )

* **Network Chart** - Requires: networkx and pygraphviz
( https://gramps-project.org/wiki/index.php?title=NetworkChart )
* [**Family Sheet**]( https://gramps-project.org/wiki/index.php?title=Family_Sheet ) - Requires: Pillow
* [**Graph View**]( https://gramps-project.org/wiki/index.php?title=Graph_View ) - Requires: PyGoocanvas and Goocanvas (python-pygoocanvas, gir1.2-goocanvas-2.0).
* [**Network Chart**]( https://gramps-project.org/wiki/index.php?title=NetworkChart ) - Requires: networkx and pygraphviz
* [**PedigreeChart**]( https://gramps-project.org/wiki/index.php?title=PedigreeChart ) - Can optionally use - numpy if installed

* **PedigreeChart** - Can optionally use - numpy if installed
( https://gramps-project.org/wiki/index.php?title=PedigreeChart )

No longer needed:
-----------------
Expand All @@ -164,20 +152,22 @@ No longer needed:
**python glade bindings**

* Since Gramps 3.1:
**yelp** - Gnome help browser. No offline help is shipped see Gramps website for User manual
**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:

* https://www.gramps-project.org/wiki/index.php?title=User_manual
The [User Manual](https://www.gramps-project.org/wiki/index.php?title=User_manual) is maintained on the Gramps website.


Issue Tracker
Bug Tracker
-------------
Gramps bug and issue tracker can be found [here](https://gramps-project.org/bugs/my_view_page.php).

Use the Gramps [Bug Tracker](https://gramps-project.org/bugs/my_view_page.php) to report bugs and suggest new features.


Translation
-------------
Gramps uses Hosted Weblate for its translations:

* https://hosted.weblate.org/engage/gramps-project
Gramps uses [Hosted Weblate](https://hosted.weblate.org/engage/gramps-project) for its translations.

0 comments on commit 90dde2c

Please sign in to comment.