Skip to content

Commit 0b46eee

Browse files
authored
Update README.md (#160)
1 parent 0ddf299 commit 0b46eee

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,16 @@ To upgrade, simply run the `pip install` command with the `-U` option:
2424
`pip install -U viam-sdk`
2525

2626
### Installing from Source
27-
The Viam Python SDK uses native libraries to support communication over WebRTC, which will allow you to connect to robots that are not on the same network. In order to facilitate that communication, there is a [Rust SDK](https://github.com/viamrobotics/viam-rust-sdk) that contains the necessary protocols. Therefore, to build from source, you will need both the Rust SDK and the Rust compiler.
27+
The Viam Python SDK uses native libraries to support communication over WebRTC, which will allow you to connect to robots that are not on the same network. In order to facilitate that communication, there is a [Rust utils repo](https://github.com/viamrobotics/rust-utils) that contains the necessary protocols. Therefore, to build from source, you will need both the Rust utils and the Rust compiler.
2828

2929
1. Download/clone this repository
30-
1. Download/clone the [Rust SDK](https://github.com/viamrobotics/viam-rust-sdk)
30+
1. Download/clone the [Rust utils](https://github.com/viamrobotics/rust-utils)
3131
1. [Install Rust](https://www.rust-lang.org/tools/install) if not already available
32-
1. From the `viam-rust-sdk` directory, run `cargo build`
32+
1. From the `rust-utils` directory, run `cargo build`
3333
* You can optionally provide the `--release` flag: `cargo build --release`
34-
1. Find the compiled library in `viam-rust-sdk/target/debug/libviam.*`
35-
* If you provided the `--release` flag, the enclosing directory will be `release`: `viam-rust-sdk/target/release/libviam.*`
36-
* The extension of the executable will depend on your operating system. For example, on macOS it will be `libviam.dylib`, whereas on Linux it will be `libviam.so`
34+
1. Find the compiled library in `rust-utils/target/debug/libviam_rust_utils.*`
35+
* If you provided the `--release` flag, the enclosing directory will be `release`: `rust-utils/target/release/libviam_rust_utils.*`
36+
* The extension of the executable will depend on your operating system. For example, on macOS it will be `libviam_rust_utils.dylib`, whereas on Linux it will be `libviam_rust_utils.so`
3737
1. Copy the compiled library to the directory `viam-python-sdk/src/viam/rpc/`
3838
1. From the `viam-python-sdk` directory, run `poetry build` to create an installable package
3939
1. Find the newly created installable package located in `viam-python-sdk/dist/` and pip install it directly, e.g.: `pip install viam-python-sdk/dist/viam_sdk-0.1.0-py3-none-any.whl`

0 commit comments

Comments
 (0)