improve configuration details on readme #5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pxalcantara
force-pushed
the
improve-readme
branch
from
cbc51cd to
e1199bc
Compare
mateus-amarante
requested changes
May 1, 2021
There was a problem hiding this comment.
Nice addition!
Just check my comments and fix the CI errors. You can easily check this in vscode with the orise's workspace.
Comment on lines
33
to
41
| ```json | ||
| // FOLDERS | ||
| "folders": [ | ||
| { | ||
| "path": "foxy_ws" | ||
| } | ||
| ], | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Actually, you can do it more easily through the user interface. You could simply reference this tutorial instead.
README.md
Outdated
|
|
||
| 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: |
There was a problem hiding this comment.
Markdownlint complains about this line size. Consider splitting them into two lines (a single enter do not jump lines in the rendered output)
pxalcantara
force-pushed
the
improve-readme
branch
from
cec69f9 to
7a02ea7
Compare
Done! |
mateus-amarante
approved these changes
May 1, 2021
caioaamaral
approved these changes
May 2, 2021
|
Nice Work |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improve the README file with more details about the
ros2.code-workspaceconfiguration and adding some possibility to use different workspaces.