Skip to content

Commit 85747bc

Browse files
author
Anas Abou Allaban
authoredMar 21, 2020
Update README (#157)
* Update README Signed-off-by: Anas Abou Allaban <[email protected]>
1 parent 8a3d321 commit 85747bc

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed
 

‎README.md

+15
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,21 @@ sudo pip3 install -U setuptools pip
1818
sudo pip3 install colcon-ros-bundle
1919
```
2020

21+
# How it works
22+
23+
`colcon bundle` performs the following steps to bundle your package:
24+
25+
1. Parse package dependencies through your `package.xml`.
26+
1. Add dependencies to the install list for each installer.
27+
1. Run installs in the following order:
28+
1. `apt`
29+
1. `pip`
30+
1. `pip3`
31+
1. Run the following transforms:
32+
1. Update the shebangs of scripts to use `#!/usr/bin/env`.
33+
1. Bundle your local workspace and dependencies into a standalone ROS workspace.
34+
The bundled workspace follows the format defined in [`BUNDLE_FORMAT.md`](BUNDLE_FORMAT.md).
35+
2136
# Building a bundle with `colcon bundle`
2237

2338
To build your ROS workspace into a bundle execute:

0 commit comments

Comments
 (0)