search

magicsunday / webtrees-pedigree-chart

SVG based pedigree chart module for webtrees genealogy application.
GNU General Public License v3.0
49 stars 15 forks source link

Installation instructions in the readme #63

Closed BertKoor closed 1 year ago

BertKoor commented 1 year ago

Some feedback for you after I answered a forum post https://www.webtrees.net/index.php/en/forum/help-for-release-2-1-x/38067-issue-after-installing-webtrees-pedigree-chart-module

The readme with installation instructions is not very clear for typical non-technical end users. Perhaps it's better to start with the steps they need to do. Currently it starts with Composer and Git, and there is no clue for the reader whether these are three ways to achieve the same, or whether all three paragraphs need to be executed in series.

Then after all the installation steps for end users are complete (they do want the manual install, right?) start a separate chapter for developers that want to run it from the raw source code or cloned repo.

magicsunday commented 1 year ago

Hi. Could you please take a look at the update README (https://github.com/magicsunday/webtrees-pedigree-chart/blob/master/README.md). What do you think, are the changes sufficient and understandable for non-technical users?

BertKoor commented 1 year ago

Look better indeed. Many thanks on behalf of your future users!