From b7122a129141db4b082ea1705c24bd9006bec6ea Mon Sep 17 00:00:00 2001 From: Simone Rondelli Date: Tue, 12 Oct 2021 12:27:05 -0400 Subject: [PATCH 1/3] [GAIAPLAT-1521] Add direct_access example README.md --- production/examples/direct_access/README.md | 28 +++++++++++++++++++++ production/examples/incubator/README.md | 22 ++++++++-------- 2 files changed, 39 insertions(+), 11 deletions(-) create mode 100644 production/examples/direct_access/README.md diff --git a/production/examples/direct_access/README.md b/production/examples/direct_access/README.md new file mode 100644 index 000000000000..0e1683593f9b --- /dev/null +++ b/production/examples/direct_access/README.md @@ -0,0 +1,28 @@ +# Direct Access Demo +A demo of the Gaia Direct Access API. + +## Build Instructions +These instructions assume you have installed the SDK and have installed the `clang` and `cmake` tools. See the SDK User's Guide for instructions on how to do this. + +1. We suggest copying the sources to a new directory so that you always have a backup in the installed folder if you want to go back. + ```shell + mkdir direct_access + cd direct_access + cp -r /opt/gaia/examples/direct_access/* . + ``` +2. Create a build directory (in this case it is under the current *incubator/* folder and build. + ```shell + mkdir build + cd build/ + cmake .. + make + ``` +3. If everything runs successfully the `hospital` executable will be built. + +# Running the Demo + +You can simply run the `hospital` binary from the build folder: + +```shell +./hospital +``` diff --git a/production/examples/incubator/README.md b/production/examples/incubator/README.md index b5258d491b01..d5dd46b2ff0a 100644 --- a/production/examples/incubator/README.md +++ b/production/examples/incubator/README.md @@ -5,18 +5,18 @@ A demo of a rule-based system for controlling the temperature of two incubators. These instructions assume you have installed the SDK and have installed the *clang* and *cmake* tools. See the SDK User's Guide for instructions on how to do this. 1. We suggest copying the sources to a new directory so that you always have a backup in the installed folder if you want to go back. -``` -mkdir incubator -cd incubator -cp -r /opt/gaia/examples/incubator/* . -``` + ```shell + mkdir incubator + cd incubator + cp -r /opt/gaia/examples/incubator/* . + ``` 2. Create a build directory (in this case it is under the current *incubator/* folder and build. -``` -mkdir build -cd build/ -cmake .. -make -``` + ```shell + mkdir build + cd build/ + cmake .. + make + ``` 3. If everything runs successfully the *incubator* executable will be built. # Running the Demo From 192bc2f1450b5a4974b40b174ad8c46649bfca4c Mon Sep 17 00:00:00 2001 From: Simone Rondelli Date: Tue, 12 Oct 2021 15:11:25 -0400 Subject: [PATCH 2/3] Address PR feedback. --- production/examples/direct_access/README.md | 8 ++++---- production/examples/incubator/README.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/production/examples/direct_access/README.md b/production/examples/direct_access/README.md index 0e1683593f9b..c46dc2fefe27 100644 --- a/production/examples/direct_access/README.md +++ b/production/examples/direct_access/README.md @@ -4,24 +4,24 @@ A demo of the Gaia Direct Access API. ## Build Instructions These instructions assume you have installed the SDK and have installed the `clang` and `cmake` tools. See the SDK User's Guide for instructions on how to do this. -1. We suggest copying the sources to a new directory so that you always have a backup in the installed folder if you want to go back. +1. To preserve the initial state of the sample code, copy the source files to a new folder. ```shell mkdir direct_access cd direct_access cp -r /opt/gaia/examples/direct_access/* . ``` -2. Create a build directory (in this case it is under the current *incubator/* folder and build. +2. Create the build folder under the current `direct_access/` folder and initiate the build. ```shell mkdir build cd build/ cmake .. make ``` -3. If everything runs successfully the `hospital` executable will be built. +3. The output of the build is an executable the 'hospital' executable. # Running the Demo -You can simply run the `hospital` binary from the build folder: +To run the `hospital` binary from the build folder use the following command: ```shell ./hospital diff --git a/production/examples/incubator/README.md b/production/examples/incubator/README.md index d5dd46b2ff0a..2ca08d709220 100644 --- a/production/examples/incubator/README.md +++ b/production/examples/incubator/README.md @@ -4,20 +4,20 @@ A demo of a rule-based system for controlling the temperature of two incubators. ## Build Instructions These instructions assume you have installed the SDK and have installed the *clang* and *cmake* tools. See the SDK User's Guide for instructions on how to do this. -1. We suggest copying the sources to a new directory so that you always have a backup in the installed folder if you want to go back. +1. To preserve the initial state of the sample code, copy the source files to a new folder. ```shell mkdir incubator cd incubator cp -r /opt/gaia/examples/incubator/* . ``` -2. Create a build directory (in this case it is under the current *incubator/* folder and build. +2. Create the build folder under the current `incubator/` folder and initiate the build. ```shell mkdir build cd build/ cmake .. make ``` -3. If everything runs successfully the *incubator* executable will be built. +3. The output of the build is an executable the 'incubator' executable. # Running the Demo The demo operates in two modes: a show mode and a sim mode. From 1bf60ab8ae5c6a66d976c5a1f832fed9971db423 Mon Sep 17 00:00:00 2001 From: Simone Rondelli Date: Tue, 12 Oct 2021 15:17:14 -0400 Subject: [PATCH 3/3] Address PR feedback --- production/examples/direct_access/README.md | 8 ++++---- production/examples/incubator/README.md | 6 +++--- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/production/examples/direct_access/README.md b/production/examples/direct_access/README.md index c46dc2fefe27..57297375a110 100644 --- a/production/examples/direct_access/README.md +++ b/production/examples/direct_access/README.md @@ -4,24 +4,24 @@ A demo of the Gaia Direct Access API. ## Build Instructions These instructions assume you have installed the SDK and have installed the `clang` and `cmake` tools. See the SDK User's Guide for instructions on how to do this. -1. To preserve the initial state of the sample code, copy the source files to a new folder. +1. To preserve the initial state of the sample code, copy the source files to a new directory. ```shell mkdir direct_access cd direct_access cp -r /opt/gaia/examples/direct_access/* . ``` -2. Create the build folder under the current `direct_access/` folder and initiate the build. +2. Create the build directory under the current `direct_access/` directory and initiate the build. ```shell mkdir build cd build/ cmake .. make ``` -3. The output of the build is an executable the 'hospital' executable. +3. The output of the build is the 'incubator' executable. # Running the Demo -To run the `hospital` binary from the build folder use the following command: +To run the `hospital` binary from the build directory use the following command: ```shell ./hospital diff --git a/production/examples/incubator/README.md b/production/examples/incubator/README.md index 2ca08d709220..9c2477bf02f2 100644 --- a/production/examples/incubator/README.md +++ b/production/examples/incubator/README.md @@ -4,20 +4,20 @@ A demo of a rule-based system for controlling the temperature of two incubators. ## Build Instructions These instructions assume you have installed the SDK and have installed the *clang* and *cmake* tools. See the SDK User's Guide for instructions on how to do this. -1. To preserve the initial state of the sample code, copy the source files to a new folder. +1. To preserve the initial state of the sample code, copy the source files to a new directory. ```shell mkdir incubator cd incubator cp -r /opt/gaia/examples/incubator/* . ``` -2. Create the build folder under the current `incubator/` folder and initiate the build. +2. Create the build directory under the current `incubator/` directory and initiate the build. ```shell mkdir build cd build/ cmake .. make ``` -3. The output of the build is an executable the 'incubator' executable. +3. The output of the build is the 'incubator' executable. # Running the Demo The demo operates in two modes: a show mode and a sim mode.