diff --git a/README.md b/README.md index e17c2e7..dbb451e 100755 --- a/README.md +++ b/README.md @@ -1,42 +1,31 @@ -Piwigo logo +# PiwigoImagesAndGPX -Manage your photo library. Piwigo is open source photo gallery software for the web. Designed for organisations, teams and individuals. +Create an map which can display one GPX file and/or Images from a piwigo category +Demo (map on the top) : http://leo.lstronic.com/piwigo/index.php?/category/6 -![screenshot](https://piwigo.org/screenshots/github-screenshot-2.10.jpg) +# Installation -The [piwigo.org](https://piwigo.org) website introduces you to Piwigo. You'll find a demo, forums, wiki and news. - -## Requirements +Put the `imagesInCat.php` file and `iFrameGPX` folder in your piwigo folder. +Add GPX files in the `iFrameGPX/GPS/` folder. - * A webserver (Apache or nginx recommended) - * PHP 7.4+. Piwigo can run with PHP 7.0+ but these end-of-life versions are no longer maintained and may expose your site to security vulnerabilities. - * MySQL 5 or greater or MariaDB equivalent - * ImageMagick (recommended) or PHP GD +You will need to install piwigo-openstreetmap plugin, and geolocate some photos. -## Quick start install +You will have to change the IGN API key if you want to use IGN baselayer -### NetInstall +# Usage - * Download the [NetInstall script](https://piwigo.org/download/dlcounter.php?code=netinstall) - * Transfer the script to your web space with any FTP client - * Open the script in you web browser (for example http://example.com/piwigo-netinstall.php) and follow the steps +## Parameters -[More information](https://piwigo.org/guides/install/netinstall) +When asking the `iFrameGPX/index.php` file, you can pass some **GET** attributes : -### Manual + * `dark`, if set, will use dark theme. Default = clear + * `scrollwheel`, if set, will enable scroll by mouse wheel on the map. Default = disable + * `basemap`, is the base map layer, can be : *osmfr*, *outdoor*, *outdoora*, *ostopo*, *ign*. + * `catID`, is the ID of a Piwigo category where to take photos, display photos with correct permissions. By default no photos + * `gpxID`, is the exact filename of the gpx file (without .gpx) which is on `iFrameGPX/GPS/` folder. will display nothing if the file doesn't exists. - * Download the [latest stable version](https://piwigo.org/download/dlcounter.php?code=latest) and unzip it - * Transfer everything to your web space with any FTP client - * Open your website (for example http://example.com/piwigo) and follow the steps +## Example of usage -[More information](https://piwigo.org/guides/install/manual) +Here is the code to insert using iframe, enabling HTML5 fullscreen API : -If you do not have your own server, consider the [piwigo.com](https://piwigo.com/) hosting solution. - -## Contributing - -Piwigo is widely driven by its community; if you want to improve the code, fork this repo and submit your changes to the `master` branch. See our [Contribution guide](https://github.com/Piwigo/Piwigo/blob/master/docs/CONTRIBUTING.md). - -## License - -Piwigo is released under the GPL v2 license. See our [Copying details](https://github.com/Piwigo/Piwigo/blob/master/COPYING.txt). +