Skip to content

Commit

Permalink
[GAIAPLAT-1521] Add direct_access example README.md (#1005)
Browse files Browse the repository at this point in the history
- Add direct_access example README.md
- Minor fixes to the incubator README.md
  • Loading branch information
simone-gaia authored Oct 12, 2021
1 parent 70f93c3 commit 108f8a2
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 14 deletions.
28 changes: 28 additions & 0 deletions production/examples/direct_access/README.md
Original file line number Diff line number Diff line change
@@ -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. 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 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 the 'incubator' executable.

# Running the Demo

To run the `hospital` binary from the build directory use the following command:

```shell
./hospital
```
28 changes: 14 additions & 14 deletions production/examples/incubator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
```
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
```
3. If everything runs successfully the *incubator* executable will be built.
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 directory under the current `incubator/` directory and initiate the build.
```shell
mkdir build
cd build/
cmake ..
make
```
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.
Expand Down

0 comments on commit 108f8a2

Please sign in to comment.