Skip to content

Commit 54cabc0

Browse files
committed
🔨 Updated root README.md to mimick that of humble_devel.
Signed-off-by: gary.bey <gary.bey@kabam.ai>
1 parent 47516ed commit 54cabc0

1 file changed

Lines changed: 9 additions & 33 deletions

File tree

README.md

Lines changed: 9 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,17 @@ A ROS2 package that **simulates a camera**, providing ROS messages from **playin
1818
**Run** the command below.
1919

2020
```bash
21-
cd $HOME
22-
git clone https://github.com/cardboardcode/virtual_camera.git --branch humble_devel --single-branch --depth 1
23-
cd ~/virtual_camera
24-
source /opt/ros/jazzy/setup.bash
25-
colcon build
21+
git clone https://github.com/cardboardcode/virtual_camera.git --branch jazzy_devel --single-branch --depth 1 && cd virtual_camera
22+
```
23+
24+
```bash
25+
source /opt/ros/jazzy/setup.bash && colcon build
2626
```
2727

2828
## **Run** :rocket:
2929

3030
Run the commands below to run `virtual_camera` ROS 2 node:
3131

32-
```bash
33-
cd ~/virtual_camera
34-
source install/local_setup.bash
35-
```
36-
37-
#### **Run Options**
38-
3932
```bash
4033
# For running without image-viewer
4134
./scripts/run.bash
@@ -80,28 +73,11 @@ This section is for **users who do not want to worry about installing all depend
8073
docker build --tag vcam_image:jazzy .
8174
```
8275

83-
**Enable** display to be forwarded from container to host.
76+
**Run** the docker image.
8477

8578
```bash
86-
#
87-
xhost +local:docker
79+
bash scripts/2_create_docker_container.bash
8880
```
8981

90-
**Run** the docker image as container.
91-
```bash
92-
docker run -it \
93-
--ipc host \
94-
--net host \
95-
--name vcam_jazzy_test_container \
96-
-v $(pwd):/home/user/virtual_camera \
97-
-e DISPLAY=$DISPLAY \
98-
-v /tmp/.X11-unix:/tmp/.X11-unix \
99-
-u 1000 \
100-
vcam_image:jazzy /bin/bash
101-
```
102-
103-
**Access the docker container:
104-
```bash
105-
docker start vcam_jazzy_test_container && docker exec -it vcam_humble_test_container bash
106-
107-
```
82+
#### **Maintainer(s)** :eyeglasses:
83+
- [cardboardcode](https://github.com/cardboardcode)

0 commit comments

Comments
 (0)