Skip to content

Commit 94bb781

Browse files
committed
update readme
1 parent 6735e78 commit 94bb781

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,34 @@
22
## Using this package
33

44
### Installation
5+
6+
#### Docker
7+
If using Ubuntu, you may skip this step. All other distributions must create a Docker environment. This container includes ROS2 Humble.
8+
9+
```
10+
docker run -it --net=host --device /dev/dri/ -e DISPLAY=$DISPLAY -v $HOME/.Xauthority:/root/.Xauthority:ro osrf/ros:humble-desktop
11+
```
12+
13+
After the docker environment has downloaded, update the system and download the UR robot drivers:
14+
```
15+
apt update -y && apt upgrade -y
16+
apt install python3-venv -y
17+
apt install ros-$ROS_DISTRO-ur -y
18+
cd ~
19+
```
20+
21+
22+
#### Installing this package
523
1. Clone this repository into your local directory:
624
```
7-
git clone git@github.com:OSUrobotics/pybullet-tree-sim.git
25+
git clone https://github.com/OSUrobotics/pybullet-tree-sim.git
826
```
927
2. Create a virtual environment. Python's `venv` is encouraged:
1028
```
29+
cd pybullet-tree-sim
1130
python3 -m venv venv
1231
source venv/bin/activate
1332
```
14-
Windows users should activate using the Windows-specific venv scripts.
1533

1634
3. Install using pip:
1735
```
@@ -26,6 +44,7 @@ mesh_downloader
2644
```
2745
This command will extract the zip file for you. It is a large file and will take several minutes.
2846

47+
2948
### Adding trees
3049
All trees should be defined by their origin namespace, the tree type, and the tree id. Tree ids should be zero-padded by 5 spaces.
3150

0 commit comments

Comments
 (0)