aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..943679c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+AGL Application Launcher service reference implementation
+
+`applaunchd` is a simple service for launching applications from other
+applications. It exposes an interface named 'org.automotivelinux.AppLaunch' on
+on the D-Bus session bus and can be autostarted by using this interface name.
+
+This interface can be used to:
+- retrieve a list of available applications
+- request that a specific application be started by using the 'start' method
+- subcribe to the 'started' and/or 'terminated' signals in order to be
+ notified when an application started successfully or terminated
+
+For more details about the D-Bus interface, please refer to the file
+`data/org.automotivelinux.AppLaunch.xml`.
+
+Applications can be started either through D-Bus activation (using their D-Bus
+name) or by specifying a command line to be executed, and are monitored until
+they exit. Please note `applaunchd` allows only one instance of a given
+application.
+
+AGL repo for source code:
+https://gerrit.automotivelinux.org/gerrit/#/admin/projects/src/applaunchd
+
+You can also clone the source repository by running the following command:
+```
+$ git clone https://gerrit.automotivelinux.org/gerrit/src/applaunchd
+```