Remove multimedia app from HomeScreen overview documentation
[staging/HomeScreen.git] / README.md
index b3845aa..c2b844c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,48 +1,47 @@
-AGL Home Screen reference implementation
-
+This project contains:
+
+HomeScreen: AGL Home Screen reference implementation
+HomeScreenAppFrameworkBinderAGL: Binder for the AGL application framework
+HomeScreenSimulator: AGL Home Screen Simulator for development
+InputEventManager: AGL Input event manager
+interfaces: the D-Bus interface introspections
+libhomescreen: HomeScreen API C++ shared library
+SampleAppTimeDate: AGL Sample Application for Home Screen Statusbar
+SampleHomeScreenInterfaceApp: sample application to show how to use libhomescreen
+WindowManager: AGL WindowManager reference implementation
 
 AGL repo for source code:
-https://gerrit.automotivelinux.org/gerrit/#/admin/projects/staging/HomeScreen
+https://gerrit.automotivelinux.org/gerrit/gitweb?p=staging%2FHomeScreen.git
+
 AGL repo for bitbake recipe:
-https://gerrit.automotivelinux.org/gerrit/#/admin/projects/AGL/meta-agl-demo
-[...]/recipes-hmi/homescreen
-
-
-
-v0.0.1
-06/01/2016
-
-#new features
-- initial version
-- first implementation of home screen
-- fix HMI layout (will be configurable in the future)
-- dBus as IPC (may change in the future)
-- no interaction with application manager so far
-- multi-lanuage support
-- day/night mode support
-- initial status bar implementation (interface will be enhanced in the future)
-- initial control bar implementation
-- MPLv2.0 license
-- input device simulator for developer build (not functional right now)
-- system settings simulator for developer build (day/night mode switch functional right now)
-- using QSettings for local app setting storage (may change in the future)
-- first popup implementation (single popup support for now; multiple popup not defined; interface will change)
-- only one instance of the app allowed
-
-#TODOs
-- many settings have to be read from the system somewhere during app startup. This is not available right now
-- interaction with application manager
-- interaction with wayland compositor
-- define and implement input device event handler
-- replace my HMI design with the official AGL design (graphics/icons...)
-- implement example HMI layouts
-- rename dBus objects (internal/external)
-- fix font issues on target
-- more documentation ;)
-- add animations
-- much more...
-
-Thanks to Umar Irshad for his free iconset available here:
-https://dribbble.com/shots/1569128-Freebie-48-Bubbles-Iconset
+https://gerrit.automotivelinux.org/gerrit/gitweb?p=AGL/meta-agl-demo.git;a=blob;f=recipes-demo-hmi/homescreen/homescreen_git.bb
+
+
+
+
+Quickstart:
+
+Instructions for building HomeScreen app
+----------------------------------------
+
+The HomeScreen app is part of the 
+packagegroup-agl-demo-platform
+packagegroup.
+
+This also includes the following apps:
+- HomeScreenAppFrameworkBinderAGL
+- InputEventManager
+- SampleAppTimeDate
+- SampleHomeScreenInterfaceApp
+- WindowManager
+
+And the library
+- libhomescreen
+
 
+To build all the above, follow the instrucions on the AGL
+documentation website:
+http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/source-code.html#features-supported-by-aglsetup
 
+Please activate the "agl-demo" feature when running the aglsetup script:
+http://docs.automotivelinux.org/docs/getting_started/en/dev/reference/source-code.html#features-supported-by-aglsetup