Skip to content

Commit

Permalink
doc(README_json README_shell): clarify the usage of PLAT argument
Browse files Browse the repository at this point in the history
- Add note clarifying the usage of <PLAT> command line argument

Co-authored-by: Farshid Tavakolizadeh <email@farshid.ws>
Signed-off-by: Lincoln Wallace <lincoln.wallace@canonical.com>
  • Loading branch information
2 people authored and HongAun-Intel committed May 6, 2024
1 parent 7732a89 commit 8bbc470
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README_json.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ OPCUA-SERVER is a C-application that can transmit and receive ETH_UADP packets u
AF_PACKET or AF_XDP sockets using libopen62541 (OPCUA-based library) APIs. It
accepts only 1 .json.i file as input.


**NOTE:** The `PLAT` command line argument refers to either the CPU platform
or the ethernet controller (e.g. the [i225](json/i225)), see in [json folder](json)
the available platforms.

### About: 1-port

Very simple, just 1 pub/sub thread
Expand Down
4 changes: 4 additions & 0 deletions README_shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ to each other via an Ethernet connection and user has a terminal open in the
This example requires multiple pin header connections for (pulse-per-second)
PPS and (auxiliary timestamping) AUXTS.

**NOTE:** The `PLAT` command line argument refers to either the CPU platform
or the ethernet controller (e.g. the [i225](shell/i225)), see in [shell folder](shell)
the available platforms.

0. [Board A & B] Build the project.

```sh
Expand Down

0 comments on commit 8bbc470

Please sign in to comment.