Skip to content

Commit 15e9826

Browse files
committed
README.md changes requested during review
1 parent bb45fdd commit 15e9826

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Reference implementation in Java for the Cognitive Spaces Websocket client
1+
# Reference implementation in Java for the Watson Assistant Solutions Audio Gateway client
22

33
This application is responsible for audio streaming on the client to and from the server using the WebSocket protocol. See the Client Interface Specification for details on the messages used to authenticate and converse with the server.
44

@@ -70,9 +70,7 @@ $ scp target/wpa-1.4-SNAPSHOT.jar pi@192.168.1.101:~/watson
7070
```
7171

7272
## Run
73-
Copy `configure.properties.example` to `configure.properties` into the the `~/watson/config` directory of the device. Provide configuration and credential information and options by editing the following properties:
74-
75-
The `start` directory contains startup scripts for both debug and non-debug modes. These scripts can be copied to the `watson` directory on the device.
73+
Copy `configure.properties.example` to `configure.properties` into the the `~/watson/config` directory of the device. A properly configured `configure.properties` file must exist in the `~/watson/config` directory for the client to run. Provide configuration and credential information and options by editing the following properties:
7674

7775
### Required Connection Information
7876
* `host` The URL of the Audio Gateway server (should NOT include the protocol prefix such as "https://")
@@ -121,6 +119,15 @@ $ java -jar target/wpa-1.4-SNAPSHOT.jar
121119

122120
Note: the primary logging control is configured with the [Log4J Configuration](src/main/java/log4j2.xml). These controls will be moved there as specific loggers in the future.
123121

122+
### Commands to Run the Client
123+
The `start` directory in the project contains startup scripts for both debug and non-debug modes. These scripts can be copied to the `~/watson` directory on the device and be used to run the client.
124+
125+
The commands to run in standard mode are:
126+
(Raspberry Pi, Linux, Apple)
127+
`sudo java -jar wpa-1.4-SNAPSHOT.jar`
128+
(Windows)
129+
`java -jar wpa-1.4-SNAPSHOT.jar`
130+
124131

125132
## Socket Interface
126133
The client provides a socket command and audio interface to allow remote control of the client (rather than through the GPIO, local microphone, and speaker).

0 commit comments

Comments
 (0)