Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[GAIAPLAT-1521] Add direct_access example README.md #1005

Merged
merged 3 commits into from
Oct 12, 2021
Merged

[GAIAPLAT-1521] Add direct_access example README.md #1005

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7122a1
[GAIAPLAT-1521] Add direct_access example README.md
simone-gaia Oct 12, 2021
192bc2f
Address PR feedback.
simone-gaia Oct 12, 2021
1bf60ab
Address PR feedback
simone-gaia Oct 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions production/examples/direct_access/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question: For this "See the SDK User's Guide for instructions on how to do this." do we want to point them to the readme that we are adding for the SDK?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to point them to the readme that we are adding for the SDK?

We should.

Note: this is copied verbatim from the incubator demo README. If we change this we should change that too.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an existing Jira to review and update the readme for the samples.


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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The output of the build is the 'hospital' executable.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Donbe.


# 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
Expand Down
6 changes: 3 additions & 3 deletions production/examples/incubator/README.md
View file
Open in desktop
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.
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.
Expand Down