Skip to content

Commit

Permalink
Improve the install instructions
Browse files Browse the repository at this point in the history
Summary: As requested at #2

Reviewed By: krallin

Differential Revision: D30040295

fbshipit-source-id: 6774defa52e55159c7e153eb0521a2fbc6401815
  • Loading branch information
ndmitchell authored and facebook-github-bot committed Aug 2, 2021
1 parent e0b6a15 commit b7ae956
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Expand Up @@ -16,7 +16,9 @@ The functionality provided by Gazebo is not stable, and continues to evolve with

## Using Gazebo

Gazebo can be installed with the standard `cargo install` pattern. The two relevant directories are `gazebo` (which contains the source to Gazebo itself) and `gazebo_derive` (which contains support for `#[derive(Dupe)]` and other Gazebo traits). Usually you will directly import `gazebo`, but `gazebo_derive` is a required transitive dependency if you are sourcing the library from GitHub.
Gazebo can be depended upon by adding `gazebo` to your `[dependencies]`, using the standard [Cargo patterns](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html).

The two interesting directories in this repo are `gazebo` (which contains the source to Gazebo itself) and `gazebo_derive` (which contains support for `#[derive(Dupe)]` and other Gazebo traits). Usually you will directly import `gazebo`, but `gazebo_derive` is a required transitive dependency if you are sourcing the library from GitHub.

## Making a release

Expand Down

0 comments on commit b7ae956

Please sign in to comment.