Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve configuration details on readme #5

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,37 @@ To work with containers, this package provides the helper script `setup_workspac

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

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:

- foxy_ws
- `.vscode-format`
- `ros2.code-workspace`
- *build*
- *install*
- *log*
- *src*

And you must redefine the `COLCON_WORKSPACE_FOLDER` variable:

```sh
export COLCON_WORKSPACE_FOLDER=/home/orise/foxy_ws
```

### Folders Configuration

In order to have the desired folders opened when you open the VSCode workspace you should add them to the `ros2.code-workspace`:

```json
// FOLDERS
"folders": [
{
"path": "foxy_ws"
}
],
```
Another way of doing this is using graphical interface. Check [this tutorial](https://code.visualstudio.com/docs/editor/multi-root-workspaces#_adding-folders) for more information

## Workspace features

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