summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDominik Holland <dominik.holland@pelagicore.com>2016-03-18 09:04:57 +0100
committerDominik Holland <dominik.holland@pelagicore.com>2016-03-18 13:07:52 +0000
commit97a8516378751904e2cf29aa3ced2d562684f490 (patch)
tree74fe165b7b0a74395acbc9fbb4ad3ba77e6a5cff /README.md
parentd350c1ee30be866c59650db3ebdc6100882eae1f (diff)
downloadneptune-ui-97a8516378751904e2cf29aa3ced2d562684f490.tar.gz
Improved the Style singleton to support different style configs
The different styleConfigs are loaded using the styleConfig variable in am-config.yaml. By default it's set to "auto" which will try to adapt the UI to the current screen size. Also consolidated all the different Main*.qml files into two versions Main.qml for displaying the HUD and ClusterAndHUD.qml for showing the InstrumentCluster in a separate Window together with the HUD. Change-Id: I8332cb97528db5de4fcb478e4f943ed93174d84f Task-number: QTAUTO-21 Reviewed-by: Nedim Hadzic <nedim.hadzic@pelagicore.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
index ce350e7..54a9d30 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,19 @@ or with the Application Manager
where `AM_CONFIG_FILE` is the path to the Application Manager `config.yaml` file (inside the template-opt folder within the Application Manager delivery). The default `config.yaml` points to the `/opt/am` folder. If that folder does not exists, make sure to update the config.yaml settings to the corresponding paths.
+# Style Configuration
+
+Neptune UI supports different styleConfigs which can be used to adapt the style to the needs of the Hardware the UI should be running on.
+The following configurations are available:
+
+* no config: The UI will use the original graphics and fonts and uses a resolution of 1280x800
+* Config1920x1080: Same as no config but 1920x1080 will be used as the screen resolution and the UI elements will be scaled
+* auto: The UI will use the current Screen resolution and tries to adapt the UI as much as possible
+
+Which configuration should be used can be controlled using the styleConfig parameter in am-config.yaml. By default the "auto" configuration is used.
+If the "auto" configuration doesn't work for a specific device a own configuration can be created by copying one of the existing configurations from modules/utils and place it somehwere on the filesystem.
+The styleConfig parameter in am-config.yaml will be intepreted as file path to a QML file and if available this StyleConfig will be loaded.
+
# Media
To get the media used within the Music and Movie app, download the zipped file and place the media.db and media folder inside the home folder. The download link: https://seafile.pelagicore.net/f/3713457142/