-
Notifications
You must be signed in to change notification settings - Fork 0
improve configuration details on readme #5
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
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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" | ||
| } | ||
| ], | ||
| ``` | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Actually, you can do it more easily through the user interface. You could simply reference this tutorial instead. |
||
| ## Workspace features | ||
|
|
||
| Recommend convenient extensions, configure formatting and linting tools, and provide helper tasks and build/test/debug launchs. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Markdownlint complains about this line size. Consider splitting them into two lines (a single enter do not jump lines in the rendered output)