From c1ed839cfbdc55b9e6cc5b8dd13791c825101ee8 Mon Sep 17 00:00:00 2001 From: Chintan Parikh Date: Wed, 4 Oct 2017 06:36:36 -0700 Subject: [PATCH] Updated README with additional documentation for dial website and added markdown tags. --- README => README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) rename README => README.md (75%) diff --git a/README b/README.md similarity index 75% rename from README rename to README.md index ca321a1..8faf979 100644 --- a/README +++ b/README.md @@ -1,6 +1,18 @@ --------------------------------------------------------------------------------- -Building the DIAL server --------------------------------------------------------------------------------- +# DIAL + + +
+

+
+ +**DI**scovery **A**nd **L**aunch—is a simple protocol that second-screen devices can use to discover and launch apps on first-screen devices. + +[DIAL page](http://www.dial-multiscreen.org/) | +[DIAL protocol spec](http://www.dial-multiscreen.org/dial-protocol-specification) + + + +## Building the DIAL server 1) Define the TARGET environment variable to point to the CC compiler prefix for your target platform. @@ -10,17 +22,13 @@ Building the DIAL server For example: TARGET=/usr/local/i686-DIAL-EXAMPLE/bin/i686-DIAL-EXAMPLE make --------------------------------------------------------------------------------- -Running the DIAL server --------------------------------------------------------------------------------- +### Running the DIAL server The DIAL server should be started as a service, after the platform's networking has been initialized, and it should remain running at all times (a daemon process in the system). --------------------------------------------------------------------------------- -Building the DIAL client --------------------------------------------------------------------------------- +## Building the DIAL client The DIAL client is a standalone C++ console application you can use to test a running DIAL server implementation on your device. Unlike the server, which is built for, and meant to run on your device, the client is meant to run on @@ -37,18 +45,14 @@ header and library locations. In most cases, you can omit the TARGET define. Note: the -rpath argument passed to LDFLAGS specifies the libcurl location to the runtime linker. --------------------------------------------------------------------------------- -Running the DIAL client in interactive (menu) mode --------------------------------------------------------------------------------- +### Running the DIAL client in interactive (menu) mode 1) The DIAL client application must be running in the same subnet as the DIAL server. 2) Start the client: ./dialclient (or ./dialclient -m) The on-screen menu will list all available actions. --------------------------------------------------------------------------------- -Running the DIAL client in conformance test (non-interactive) mode --------------------------------------------------------------------------------- +### Running the DIAL client in conformance test (non-interactive) mode 1) The DIAL client application must be running in the same subnet as the DIAL server. @@ -61,9 +65,7 @@ Running the DIAL client in conformance test (non-interactive) mode ./dialclient_input.txt ./report.html --------------------------------------------------------------------------------- -DIAL client Usage --------------------------------------------------------------------------------- +## DIAL client Usage When running the DIAL client, you have the following options usage: dialclient