[GAIAPLAT-1521] Add direct_access example README.md #1005
Conversation
simone-gaia
commented
Oct 12, 2021
simone-gaia
commented
- Add direct_access example README.md
- Minor fixes to the incubator README.md
simone-gaia
requested review from
senderista,
vDonGlover,
LaurentiuCristofor,
daxhaw and
JackAtGaia
| ## 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. |
There was a problem hiding this comment.
I think "if you want to go back" can just be deleted.
There was a problem hiding this comment.
To preserve the initial state of the sample code, copy the source files to a new folder.
| 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. |
There was a problem hiding this comment.
Create a build folder. The following commands create the build folder under the current direct_access/ folder and initiate the build.
There was a problem hiding this comment.
I guess we should standardize on either "folder" or "directory" throughout the docs? The former is more informal and familiar, but has some GUI associations IMO, while the latter is perhaps more precise and more CLI-oriented?
There was a problem hiding this comment.
Agreed. I just checked my go to style guide and deciding I could not draw a fully clear decision on it, I checked how it got applied in the associated docs. In the case of Linux, directory appears to be the word of choice.
There was a problem hiding this comment.
Shortened to 2. Create the build folder under the current direct_access/ folder and initiate the build.
Let me know what do you want to do in regard to folder/directory
| cmake .. | ||
| make | ||
| ``` | ||
| 3. If everything runs successfully the `hospital` executable will be built. |
There was a problem hiding this comment.
nit: comma after "successfully"
There was a problem hiding this comment.
The output of the build is an executable name 'hospital'.
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
To run the hospital binary from the build folder use the following command:
| 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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
There is an existing Jira to review and update the readme for the samples.
| ```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. |
There was a problem hiding this comment.
The output of the build is the 'hospital' executable.
