Initial source commit

[src/libhomescreen.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..8d1290a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+This project contains:
+
+libhomescreen: HomeScreen API C++ shared library
+
+AGL repo for source code:
+https://gerrit.automotivelinux.org/gerrit/gitweb?p=staging%2FHomeScreen.git
+
+AGL repo for bitbake recipe:
+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 libhomescreen
+---------------------------------------
+
+The libhomescreen is part of the 
+packagegroup-agl-demo-platform
+packagegroup.
+
+This also includes the following apps:
+- HomeScreenAppFrameworkBinderAGL
+- InputEventManager
+- SampleAppTimeDate
+- SampleHomeScreenInterfaceApp
+- WindowManager
+
+
+
+
+
+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