summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorArseniy Movshev <dodoradio@outlook.com>2023-01-18 23:49:52 +0000
committerArseniy Movshev <dodoradio@outlook.com>2023-01-18 23:50:30 +0000
commit2678ad39c93d73d2685fb72ad65c7c89a3f96a33 (patch)
tree547973f91dd5ccbf5a8f8cfd3b5a1344f3b279f5 /README.md
parentfe738989f431448925bdacff80995e52fc5e5afe (diff)
Update readme with explanation of basic usage
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index d9f4b9d..15f655b 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,13 @@
# Asteroid Map
A map app for AsteroidOS. Depends on Qt5 and qml-asteroid. Aims to provide a useful map app optimised for small and round displays, and devices with limited connectivity.
-# Features
-- Zoom and centre your position with the tap of a button
-- Multiple compass modes to help you get your bearings
-- Set, label and edit waypoints to mark points of interest
+
+# Usage
+- Zoom with buttons instead of pinch-to-zoom.
+- Center your view by pressing the 'target' button (after forcing GPS in settings).
+- Multiple compass modes to help you get your bearings. Tap to switch between compass indicator and map bearing, reset with a long press.
+- Set waypoints to mark areas of interest with a selectable icon. Tap to edit or delete waypoints.
# Planned features and ideas for implementing them
- Manual caching/downloading of map tiles - A useful feature for going offline. The plugin already has automatic caching, but it might be worth exposing this to the user.
- Importing navigation routes - perhaps sending these over from a paired device as GPX, or something else. Probably way off in the future.
-- Some sort of navigation system on watch?
+- Some sort of navigation system running directly on the watch.