Glossary's readme

Copyright (C) 2006 Jonathan Ernst
Copyright (C) 2007-2019 Jean-Philippe Guérard
Copyright (C) 2019 Stéphane Aulery

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with the Glossary.  If not, see <https://www.gnu.org/licenses/>.
===============================================================================

License
-------
See COPYING file.

Install
-------
* What you need (recommanded)
 - PHP 7+
 - MySQL >= 5.7.5 or MariaDB => 10.2 (mysqli driver)
 - Any webserver with PHP and UTF-8 support
 - php gettext support for localization
 - php remote url opening for automatic translation

* How-to install
 - unpack the package
 - create a MySql database (with encoding utf8mb4_unicode_520_ci) and user
 - dump the content of db/structure.sql into the database
 - optionnaly dump the content of db/content.sql.gz into the database
 - rename includes/config.tpl.php into includes/config.inc.php and edit the file to reflect your configuration

* How-to update
 - delete everything but includes/config.inc.php
 - unpack the package
 - compare includes/config.tpl.php with includes/config.inc.php to see if you are missing some configuration entries
 - compare db/structure.sql with your current database structure and make changes accordingly


Localization (don't forget to send your changes to jean-philippe.guerard@tigrerayé.org)
------------
* To update the .po template:
 - xgettext --msgid-bugs-address=jean-philippe.guerard@tigrerayé.org  --package-name=glossary -c -n -s --from-code=UTF-8 --language=PHP -o locale/messages.pot index.php
 - find ./ -iname "*.php" -exec xgettext --from-code=UTF-8 --language=PHP -j -o locale/messages.pot {} \;
* To create a new translation  (replace fr_FR with your locale)
 - mkdir -p locale/fr_FR/LC_MESSAGES
 - cp locale/messages.pot locale/fr_FR/LC_MESSAGES/messages.po
* To update an existing translation (replace fr_FR with your locale and poedit with your favorite editor)
 - update the .po template
 - cd locale/fr_FR/LC_MESSAGES
 - msgmerge  --previous -s messages.po ../../messages.po -o messages.new.po
 - rm messages.po
 - mv messages.new.po messages.po
 - poedit messages.po
 - msgfmt messages.po