add link to python repo in readme #265
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
|
Edit: We good now! |
README.md
Outdated
| @@ -28,7 +28,7 @@ To upgrade, simply run the `pip install` command with the `-U` option: | |||
| ### Installing from Source | |||
| 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. | |||
|
|
|||
| 1. Download/clone this repository | |||
| 1. Download/clone [this repository] (https://github.com/viamrobotics/viam-python-sdk) | |||
There was a problem hiding this comment.
Suggested change
| 1. Download/clone [this repository] (https://github.com/viamrobotics/viam-python-sdk) | |
| 1. Download/clone [this repository](https://github.com/viamrobotics/viam-python-sdk) |
There was a problem hiding this comment.
thank you! should be fixed now
|
Not sure why the CLA is blocking you.. perhaps we don't have you in the right groups? @cheukt |
maximpertsov
approved these changes
Apr 21, 2023
stuqdog
approved these changes
Apr 21, 2023
|
yeah @njooma not sure why either, strange 👀 |
|
I just signed it, hopefully that isn't bad 😅 🤷 |
njooma
approved these changes
Apr 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While going through this tutorial users are directed to https://python.viam.dev/
I noticed that users are directed to download
this repositorybut while in the docs site they are not already present in the repository, so it is confusing.This PR adds a hyperlink to this
repositorysending users to the phython sdk repo https://github.com/viamrobotics/viam-python-sdk - which feels redundant in some cases, but in the case where that readme is read on https://python.viam.dev/ I think it makes sense to have the link for that case.Testing Evidence: