Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The install instructions aren't applicable #2

Closed
cuviper opened this issue Jul 29, 2021 · 3 comments
Closed

The install instructions aren't applicable #2

cuviper opened this issue Jul 29, 2021 · 3 comments

Comments

@cuviper
Copy link

cuviper commented Jul 29, 2021

The README says:

Gazebo can be installed with the standard cargo install pattern.

But that's only for binaries, and gazebo is a library. Shouldn't this instead talk about adding it as a dependency to Cargo.toml?

@ndmitchell
Copy link
Contributor

Thanks for bringing this up - agreed it's not quite accurate. I was going for the idea that you use the standard Cargo patterns (e.g. add to Cargo.toml, run cargo install). Although given the ubiquity of those patterns in the Rust ecosystem, and given that Gazebo is 100% normal, perhaps we just need to say nothing? Taking a look at a few representative Rust libraries, a lot of them just omit this. Or if you think some specific information would be useful, what do you think that would be? Or is there a good link to point people at how to make use of a library?

@cuviper
Copy link
Author

cuviper commented Jul 30, 2021

Maybe you could just say that it's a standard crates.io dependency, and link here:
https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html

facebook-github-bot pushed a commit that referenced this issue Aug 2, 2021
Summary: As requested at #2

Reviewed By: krallin

Differential Revision: D30040295

fbshipit-source-id: 6774defa52e55159c7e153eb0521a2fbc6401815
@ndmitchell
Copy link
Contributor

Great idea - fixed in b7ae956.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants