diff --git a/README.md b/README.md index 8cd35204..bc310651 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,52 @@ Future plans: - **📆 Events on the map:** Know where you need to go next! - **🗺 Different projections:** The [Mercator projection](https://en.wikipedia.org/wiki/Mercator_projection) is very biased, as you can see from [The True Size of Africa](http://kai.sub.blue/en/africa.html). Another view like the [Gall-Peters projection](https://en.wikipedia.org/wiki/Gall%E2%80%93Peters_projection) would be a possibility. +## User Documentation +### My Maps +Custom maps are stored by default in the "/Maps" folder. This folder can be found in the +files app. Other folders turned into map by placing a ".maps" file into it. +Content can therefore be added via: + - Webdav (Desktop and Mobile clients) + - Files app + - Maps app + +Custom maps can then be shared from the maps or any other app. + +####Sharing map +Maps can be shared using the nextcloud sharing system. +![](screenshots/shareMap.gif) + +####Favorites on custom map +Favorites on custom the custom maps are stored in the .favorites.json file. + +Shared favorite categories can be linked to a custom map. +Linked favorite categories are read-only. +They can be edited on the owners default map. +These links are stored in the ".favorite_shares.json". +![](screenshots/addFavorites.gif) + + +####Contacts on custom map +Contacts on custom maps are stored as vCards (*.vfc) files. +![](screenshots/addContacts.gif) + +####Tracks on custom map +Tracks on custom map are stored as "*.gpx files". +![](screenshots/addTracks.gif) + +####Photos on custom map +Photos are stored in the corresponding folder. +They can be added from files +![](screenshots/addPhotosFromFiles.gif) +or from maps +![](screenshots/addPhotosFromMap.gif) +Existing photo albums can be viewed +on the map by placing a ".maps" file into it. +![](screenshots/photoAlbumOnMap.gif) + +Scanning photos take time. Therefore photos are scanned in the background. +After adding photos it might take a while, +until the scan is done and the photos are shown on the map. ## 🏗 Development setup diff --git a/screenshots/addContacts.gif b/screenshots/addContacts.gif new file mode 100644 index 00000000..881893c6 Binary files /dev/null and b/screenshots/addContacts.gif differ diff --git a/screenshots/addFavorites.gif b/screenshots/addFavorites.gif new file mode 100644 index 00000000..ce9da14d Binary files /dev/null and b/screenshots/addFavorites.gif differ diff --git a/screenshots/addPhotoFromFiles.gif b/screenshots/addPhotoFromFiles.gif new file mode 100644 index 00000000..8e044d8c Binary files /dev/null and b/screenshots/addPhotoFromFiles.gif differ diff --git a/screenshots/addPhotosFromMap.gif b/screenshots/addPhotosFromMap.gif new file mode 100644 index 00000000..f0a0ed0d Binary files /dev/null and b/screenshots/addPhotosFromMap.gif differ diff --git a/screenshots/addTracks.gif b/screenshots/addTracks.gif new file mode 100644 index 00000000..d4010826 Binary files /dev/null and b/screenshots/addTracks.gif differ diff --git a/screenshots/photoAlbumOnMap.gif b/screenshots/photoAlbumOnMap.gif new file mode 100644 index 00000000..13961ab7 Binary files /dev/null and b/screenshots/photoAlbumOnMap.gif differ diff --git a/screenshots/shareMap.gif b/screenshots/shareMap.gif new file mode 100644 index 00000000..3004c860 Binary files /dev/null and b/screenshots/shareMap.gif differ