Skip to content
Snippets Groups Projects
Commit 1025fa91 authored by Montaño Sarria, Andres Felipe's avatar Montaño Sarria, Andres Felipe
Browse files

Update Readme

parent 7ffe433e
No related branches found
No related tags found
No related merge requests found
......@@ -219,19 +219,19 @@ Resources list:
- [IDE Visual Studio Code](https://health_software.pages.code.tecnalia.com/software_good_practices/ide/ide-vscode/)
- [IDEs and Debugging](https://docs.ros.org/en/rolling/How-To-Guides/ROS-2-IDEs.html)
One of the most complete guide is [Setup ROS 2 with VSCode and Docker](https://docs.ros.org/en/rolling/How-To-Guides/Setup-ROS-2-with-VSCode-and-Docker-Container.html), it is a good starting point and is maintained by the ROS Community.
One of the most complete guide is [Setup ROS 2 with VSCode and Docker](https://docs.ros.org/en/rolling/How-To-Guides/Setup-ROS-2-with-VSCode-and-Docker-Container.html), it is a good starting point and it is maintained by the ROS Community.
To summarize, some configuration files should be added to workspace. '.devconatiner' folder including 'devcontainer.json' and 'Dockerfile'. '.vscode' folder including 'launch.json', 'tasks.json', 'c_cpp_properties.json' and 'settings.json'.
To summarize, some configuration files should be added to workspace: '.devconatiner' folder including 'devcontainer.json' and 'Dockerfile', '.vscode' folder including 'launch.json' and 'tasks.json' files.
- devcontainer.json contains the configuration to launch the container on VS-Code. Including Mount points, VS-Code extensions and Shared resources.
- Dockerfile contains the configuration to add $USER to the container avoiding permission issues.
- launch.json contains the configuration to launch a ROS node in the container.
- tasks.json contains the configuration to define tasks in VS-Code.
- c_cpp_properties.json and settings.json are autogenerated by VS-Code.
- on .vscode folder, other config files appear: c_cpp_properties.json and settings.json, which are autogenerated by VS-Code, but could be modified by the user.
Examples of functional commented files are stored at [vscode_config](https://git.code.tecnalia.com/andres.montano/development_environment/-/blob/master/vscode_config)' folder.
As final remarks, the launch.json and tasks.json should be adapted to workspace/project needs. The launch.json contains the configuration to launch a ROS node in the container, it is recommended to avoid debug nodes as RViz or Gazebo (GZ), therefore the launch file should only be used to launch core project nodes.
As final remarks, the launch.json and tasks.json should be adapted to workspace/project needs. The `launch.json` contains the configuration to launch a ROS node in the container, it is recommended to avoid debug nodes like RViz or Gazebo (GZ), therefore the launch file should only be used to launch core project nodes.
In order to make easy to use the configurations, a local env could be loaded with [direnv](https://github.com/direnv/direnv) (.envrc file), but it is not mandatory.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment