Skip to content

Commit

Permalink
📝 clarify namespace
Browse files Browse the repository at this point in the history
Signed-off-by: Yuxiang Gao <[email protected]>
  • Loading branch information
yuxiang-gao committed Sep 11, 2024
1 parent c036a81 commit ab2a11b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,15 @@ pip install -e .

## Usage

First make sure you know the IP address of the robot server and the namespace it is running on.
Then you can create a client object like this:
First make sure you know the IP address of the robot server and the namespace it is running on. Namespace is set by the `--namespace` flag when starting the robot server.

On your robot:

```bash
grx run ./path/to/config.yaml --urdf-path ./path/to/urdf_folder --namespace gr/my_awesome_robot
```

Then on your local machine, you can create a client object like this:

```python
from fourier_grx_client import *
Expand Down
11 changes: 9 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,15 @@ pip install -e .

## Usage

First make sure you know the IP address of the robot server and the namespace it is running on.
Then you can create a client object like this:
First make sure you know the IP address of the robot server and the namespace it is running on. Namespace is set by the `--namespace` flag when starting the robot server.

On your robot:

```bash
grx run ./path/to/config.yaml --urdf-path ./path/to/urdf_folder --namespace gr/my_awesome_robot
```

Then on your local machine, you can create a client object like this:

```python
from fourier_grx_client import *
Expand Down

0 comments on commit ab2a11b

Please sign in to comment.