From cf9a5ba5115880c8ec8c0abc00c6720518df5be8 Mon Sep 17 00:00:00 2001 From: Rico Sonntag Date: Wed, 14 Jun 2023 08:25:26 +0200 Subject: [PATCH] Resolves #63: Update README --- README.md | 81 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 51 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 2199200..c2b0808 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,21 @@ * [Pedigree chart](#pedigree-chart) * [Installation](#installation) + * [Manual installation](#manual-installation) + * [Configuration](#configuration) + * [Usage](#usage) * [Using Composer](#using-composer) * [Using Git](#using-git) - * [Manual installation](#manual-installation) - * [Enable module](#enable-module) - * [Usage](#usage) * [Development](#development) * [Run tests](#run-tests) # Pedigree chart -This module provides an SVG pedigree chart for the [webtrees](https://www.webtrees.net) genealogy application. It -is capable to display up to 25 ancestor generations of an individual. +This module provides an SVG pedigree chart for the [webtrees](https://www.webtrees.net) genealogy application. +It is capable of displaying up to 25 generations of ancestors from an individual. + +**But beware, if you select too many generations, it may take a while and even slow down your system significantly.** ![pedigree-chart-3-generations](assets/pedigree-chart-top-bottom.png) *Fig. 1: A five-generations pedigree chart (drawn top to bottom)* @@ -26,17 +28,46 @@ is capable to display up to 25 ancestor generations of an individual. ![pedigree-chart-5-generations](assets/pedigree-chart-5-generations.png) *Fig. 2: A five-generations pedigree chart (drawn left to right)* -**Caution: If you are rendering a lot of generations, it may take a while and even slow down your system.** ## Installation Requires webtrees 2.2. +There are several ways to install the module. The method using [composer](#using-composer) is suitable +for experienced users, as a developer you can also use [git](#using-git) to get a copy of the repository. For all other users, +however, manual installation is recommended. + +### Manual installation +To manually install the module, perform the following steps: + +1. Download the [latest release](https://github.com/magicsunday/webtrees-pedigree-chart/releases/latest) of the module. +2. Upload the downloaded file to your web server. +3. Unzip the package into your ``modules_v4`` directory. +4. Rename the folder to ``webtrees-pedigree-chart`` + +If everything was successful, you should see a subdirectory ``webtrees-pedigree-chart`` with the unpacked content +in the ``modules_v4`` directory. + +Now the module has to be activated within Webtrees. + +#### Configuration +Go to the control panel (admin section) of your installation and scroll down to the ``Modules`` section. Click +on ``Charts`` (in subsection Genealogy). Enable the ``Pedigree chart`` custom module (optionally disable the original +installed pedigree chart module) and save your settings. + +![control-panel-modules](assets/control-panel-modules.png) +*Fig. 3: Control panel - Module administration* + +#### Usage +At the charts' menu, you will find a new link called `Pedigree chart`. Use the provided configuration options +to adjust the layout of the charts according to your needs. + + ### Using Composer -To install using [composer](https://getcomposer.org/), just run the following command from the command line -at the root directory of your webtrees installation. +Typically, to install with [composer](https://getcomposer.org/), just run the following command from the command line, +from the root of your Webtrees installation. ```shell -composer require magicsunday/webtrees-pedigree-chart:* --update-no-dev +composer require magicsunday/webtrees-pedigree-chart --update-no-dev ``` The module will automatically install into the ``modules_v4`` directory of your webtrees installation. @@ -46,6 +77,16 @@ To remove the module run: composer remove magicsunday/webtrees-pedigree-chart --update-no-dev ``` +Then follow the steps described in [configuration](#configuration) and [usage](#usage). + +#### Latest version +If you are using the development version of Webtrees (main branch), you may also need to install the development +version of the module. For this, please use the following command: +```shell +composer require magicsunday/webtrees-pedigree-chart:dev-master --update-no-dev +``` + + ### Using Git If you are using ``git``, you could also clone the current master branch directly into your ``modules_v4`` directory by calling: @@ -54,27 +95,7 @@ by calling: git clone https://github.com/magicsunday/webtrees-pedigree-chart.git modules_v4/webtrees-pedigree-chart ``` -### Manual installation -To manually install the module, perform the following steps: - -1. Download the [latest release](https://github.com/magicsunday/webtrees-pedigree-chart/releases/latest). -2. Upload the downloaded file to your web server. -3. Unzip the package into your ``modules_v4`` directory. -4. Rename the folder to ``webtrees-pedigree-chart`` - - -## Enable module -Go to the control panel (admin section) of your installation and scroll down to the ``Modules`` section. Click -on ``Charts`` (in subsection Genealogy). Enable the ``Pedigree chart`` custom module (optionally disable the original -installed pedigree chart module) and save your settings. - -![control-panel-modules](assets/control-panel-modules.png) -*Fig. 3: Control panel - Module administration* - - -## Usage -At the charts' menu, you will find a new link called `Pedigree chart`. Use the provided configuration options -to adjust the layout of the charts according to your needs. +Then follow the steps described in [configuration](#configuration) and [usage](#usage). ## Development