Skip to content

Commit

Permalink
Fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Ax9DTW committed May 31, 2024
1 parent 30b392a commit 00b3894
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ smip aims to make SOME/IP development in Rust feel as natural as building regula

Why is it better than something like vsomeip-rs?

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.
Also vsomeip is a very low level someip implementation and is heavily callback oriented.
For example a service definition in vsomeip may look like this:
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.
Also vSomeIP is a very low level someip implementation and is heavily callback oriented.
For example a service definition in vSomeIP may look like this:

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

# Aim

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

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

- 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`
- 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 comments on commit 00b3894

Please sign in to comment.