iox-#4 Update readme for initial release #45
Conversation
README.md
Outdated
| ## About | ||
|
|
||
| Eclipse iceoryx is a true zero-copy, inter-process communication framework with the goal to boost | ||
| autonomous driving with their demand on high data throughput and low latency. With this properties, |
There was a problem hiding this comment.
I heard the suggestion lately to not state this or mentioned earlier or phrases like that. One should really name the things again.
With this in mind you could also write With iceoryx's bandwidth and speed, is also fits ...
There was a problem hiding this comment.
Good point. I used With its bandwidth and speed, iceoryx also fits ...
| To build the examples run | ||
| ### Run the simple publisher and subscriber example | ||
|
|
||
| A good introductory example to demonstrate the inter-process communication are `publisher_simple` |
There was a problem hiding this comment.
I asked @FerdinandSpitzschnueffler for advise. The statement was: it sounds wrong and has to be completely rewritten. You speak of one (singular) good example and mix it with are (plural).
What about:
The executables publisher_simple and subscriber_simple are forming of a good introductory example.
There was a problem hiding this comment.
Well, they are two examples that work together. How about The 'publisher_simple' and 'subscriber_simple' examples are forming a good inter-process communication demonstration.?
Pre-Review Checklist for the PR Author
rustfmtiox-123-this-is-a-branch)iox-#42 commit text)task-list-completed)Notes for Reviewer
More content for the readme.
Checklist for the PR Reviewer
Post-review Checklist for the PR Author
References