Skip to content

Commit cbc51cd

Browse files
committed
improve configuration details on readme
1 parent 1c18722 commit cbc51cd

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,35 @@ To work with containers, this package provides the helper script `setup_workspac
1010

1111
Run `setup_workspace.sh --help` for more details about the script usage.
1212

13+
If you're using [ORise container](https://github.com/orise-robotics/ros_ws), it assumes that the folder `/home/orise` will be used as your woskspace to develop using ROS 2 and also, your VSCode workspace. If you want to use different workspaces inside the container, just copy the files `.vscode-format` and `ros2.code-workspace` to the root of your ROS workspace and redefine the `COLCON_WORKSPACE_FOLDER` variable. For example, let's assume that you want to use a ROS 2 woskpace called *foxy_ws*, this folder should have:
14+
15+
- foxy_ws
16+
- `.vscode-format`
17+
- `ros2.code-workspace`
18+
- *build*
19+
- *install*
20+
- *log*
21+
- *src*
22+
23+
And you must redefine the `COLCON_WORKSPACE_FOLDER` variable:
24+
25+
```sh
26+
$ export COLCON_WORKSPACE_FOLDER=/home/orise/foxy_ws
27+
```
28+
29+
### Folders Configuration
30+
31+
In order to have the desired folders opened when you open the VSCode workspace you should add them to the `ros2.code-workspace`:
32+
33+
```json
34+
// FOLDERS
35+
"folders": [
36+
{
37+
"path": "foxy_ws"
38+
}
39+
],
40+
```
41+
1342
## Workspace features
1443

1544
Recommend convenient extensions, configure formatting and linting tools, and provide helper tasks and build/test/debug launchs.

0 commit comments

Comments
 (0)