From e1199bcfc45b8d2a8a36dd584b5259afe75843a7 Mon Sep 17 00:00:00 2001 From: pxalcantara Date: Thu, 22 Apr 2021 20:48:21 -0300 Subject: [PATCH 1/2] improve configuration details on readme --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index a105c7a..f190482 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,35 @@ 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" + } + ], +``` + ## Workspace features Recommend convenient extensions, configure formatting and linting tools, and provide helper tasks and build/test/debug launchs. From 7a02ea7c098c3d1465c2017c52a1eecc12382053 Mon Sep 17 00:00:00 2001 From: pxalcantara Date: Sat, 1 May 2021 17:20:06 -0300 Subject: [PATCH 2/2] fix lint format --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f190482..ffd2fb6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ 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: +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` @@ -23,7 +24,7 @@ If you're using [ORise container](https://github.com/orise-robotics/ros_ws), it And you must redefine the `COLCON_WORKSPACE_FOLDER` variable: ```sh - $ export COLCON_WORKSPACE_FOLDER=/home/orise/foxy_ws + export COLCON_WORKSPACE_FOLDER=/home/orise/foxy_ws ``` ### Folders Configuration @@ -38,6 +39,7 @@ In order to have the desired folders opened when you open the VSCode workspace y } ], ``` +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