Skip to content
This repository was archived by the owner on Jun 2, 2025. It is now read-only.

Commit 00b3894

Browse files
committed
Fix typos
1 parent 30b392a commit 00b3894

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ smip aims to make SOME/IP development in Rust feel as natural as building regula
33

44
Why is it better than something like vsomeip-rs?
55

6-
vsomeip-rs is a Rust binding for the vsomeip C++ library. It exposes the C++ API directly to Rust developers, potentially leading to less Rust-idiomatic code.
7-
Also vsomeip is a very low level someip implementation and is heavily callback oriented.
8-
For example a service definition in vsomeip may look like this:
6+
vsomeip-rs is a Rust binding for the vSomeIP C++ library. It exposes the C++ API directly to Rust developers, potentially leading to less Rust-idiomatic code.
7+
Also vSomeIP is a very low level someip implementation and is heavily callback oriented.
8+
For example a service definition in vSomeIP may look like this:
99

1010
```rust
1111
use vsomeip_rs::*;
@@ -94,7 +94,7 @@ All of these need to be in a special impl block marked with a `methods_impl` att
9494

9595
# Aim
9696

97-
Smip aims to be a SOME/IP framework and not an implementation of SOME/IP, so its not competing with vsomeip or sommar. Currently vsomeip is used as the underlying implementation but this can be swapped with any compliant implementation in the future.
97+
Smip aims to be a SOME/IP framework and not an implementation of SOME/IP, so its not competing with [vSomeIP](https://github.com/COVESA/vsomeip) or [SommR](https://projects.eclipse.org/projects/automotive.sommr). Currently vSomeIP is used as the underlying implementation but this can be swapped with any compliant implementation in the future.
9898

9999
Key Benefits:
100100
* Macro-Based Definition: The smip macro simplifies the definition of services and methods, reducing the amount of code needed.
@@ -117,4 +117,4 @@ In another terminal,
117117
cargo run --example simple_client
118118
```
119119

120-
- You may need to set the `LD_LIBRARY_PATH` environment to a path that contains the vsomeip library as this is dynamically loaded `LD_LIBRARY_PATH=/usr/local/lib`
120+
- You may need to set the `LD_LIBRARY_PATH` environment to a path that contains the vSomeIP library as this is dynamically loaded `LD_LIBRARY_PATH=/usr/local/lib`

0 commit comments

Comments
 (0)