From 97de2629ec9aefff4afddeb253bdd3ce9d443653 Mon Sep 17 00:00:00 2001 From: BJ Dweck Date: Tue, 6 Oct 2020 15:16:27 +0200 Subject: [PATCH] Updated/Added README.md files --- README.md | 2 +- example/README.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fb5a0dd..5b8e16b 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,6 @@ The configuation directory can be specified by * Using the `--config-dir` commandline option * Default: `/etc/torch` -A fully configured example can be found [here](example/README.md) +A fully configured example can be found [here](example) See the sample [`torch.conf`](torch.conf) file for additional configuration options and details \ No newline at end of file diff --git a/example/README.md b/example/README.md index 44b269f..f0e7e21 100755 --- a/example/README.md +++ b/example/README.md @@ -2,15 +2,15 @@ The example creates a Vagrant machine configured with TORch Agent -## Instructions to Run +## Running the Example -### Install dependencies +#### Install dependencies * `docker` * `mosquitto_sub` * `apt install mosquitto-clients` -### Run the Broker +#### Run the Broker Add the following line to your `/etc/hosts` file: @@ -25,7 +25,7 @@ cd example ./run-broker.sh ``` -### Run the Subscriber +#### Run the Subscriber In a separate terminal window, run the subscriber: @@ -34,7 +34,7 @@ cd example ./run-subscriber.sh ``` -### Run TORch Agent in Vagrant +#### Run TORch Agent in Vagrant Run the Vagrant box in a third terminal window: