aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntti Hölttä <AHoelttae@luxoft.com>2018-12-20 08:50:36 +0100
committerAntti Hölttä <AHoelttae@luxoft.com>2019-03-18 16:37:19 +0100
commitd708fa07855b2264cd0fd3702df88099437f650e (patch)
treeb03cd27ec4cc79212e05edfebfd87c7bdc47995d
parentb75bb90ea3ab5babff80ef70f3ae526d7f5cc278 (diff)
Started sketching the readme
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index e69de29..99859b8 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,19 @@
+
+## what is it for?
+-for implementing cursor navigation on QML UIs
+-define items as cursor navigable, CursorNavigation backend registers items and takes care of the navigation
+-based on UI geometry, no need to define navigation paths or item relations
+-2 ways of spatial navigation: 4 way and 360. 4 way simple and good for rectangular structured UIs, 360 allows stepless movement to any direction
+
+## install
+-distributed as a qt plugin
+-build and make install
+
+
+use:
+-import in QML
+-defining item as navigable
+-input interface and connecting to it
+-focus scoping and cursors
+
+