Skip to content

Commit 108f8a2

Browse files
authored
[GAIAPLAT-1521] Add direct_access example README.md (#1005)
- Add direct_access example README.md - Minor fixes to the incubator README.md
1 parent 70f93c3 commit 108f8a2

File tree

2 files changed

+42
-14
lines changed

2 files changed

+42
-14
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Direct Access Demo
2+
A demo of the Gaia Direct Access API.
3+
4+
## Build Instructions
5+
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.
6+
7+
1. To preserve the initial state of the sample code, copy the source files to a new directory.
8+
```shell
9+
mkdir direct_access
10+
cd direct_access
11+
cp -r /opt/gaia/examples/direct_access/* .
12+
```
13+
2. Create the build directory under the current `direct_access/` directory and initiate the build.
14+
```shell
15+
mkdir build
16+
cd build/
17+
cmake ..
18+
make
19+
```
20+
3. The output of the build is the 'incubator' executable.
21+
22+
# Running the Demo
23+
24+
To run the `hospital` binary from the build directory use the following command:
25+
26+
```shell
27+
./hospital
28+
```

production/examples/incubator/README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@ A demo of a rule-based system for controlling the temperature of two incubators.
44
## Build Instructions
55
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.
66

7-
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.
8-
```
9-
mkdir incubator
10-
cd incubator
11-
cp -r /opt/gaia/examples/incubator/* .
12-
```
13-
2. Create a build directory (in this case it is under the current *incubator/* folder and build.
14-
```
15-
mkdir build
16-
cd build/
17-
cmake ..
18-
make
19-
```
20-
3. If everything runs successfully the *incubator* executable will be built.
7+
1. To preserve the initial state of the sample code, copy the source files to a new directory.
8+
```shell
9+
mkdir incubator
10+
cd incubator
11+
cp -r /opt/gaia/examples/incubator/* .
12+
```
13+
2. Create the build directory under the current `incubator/` directory and initiate the build.
14+
```shell
15+
mkdir build
16+
cd build/
17+
cmake ..
18+
make
19+
```
20+
3. The output of the build is the 'incubator' executable.
2121

2222
# Running the Demo
2323
The demo operates in two modes: a show mode and a sim mode.

0 commit comments

Comments
 (0)