Initial clean-up of VCS repos and README files #37
Conversation
This file contains 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
kzorina
reviewed
Feb 7, 2025
kzorina
reviewed
Feb 7, 2025
| > [!CAUTION] | ||
| > Current demos only make use of `agimus_dev_container:humble-devel-control`. There is no need to pull Docker images with vision dependencies. | ||
|
|
||
| Docker image is provided in a form of Development Container and can be found at [agimus-project/agimus_dev_container](https://gitlab.laas.fr/agimus-project/agimus_dev_container). Use branch `humble-devel` and refer to the README.md file for more information on how to use it. |
There was a problem hiding this comment.
should we just point to readme maybe? Also, in readme info gets a bit lost I think (f.e. setup.sh), so we should either say FOLLOW VERY CAREFULLY the README. Or just copy a sequence of steps in short form (like I did below) and maybe send for "if any questions look on readme"
There was a problem hiding this comment.
Should be better now
kzorina
reviewed
Feb 7, 2025
| ros2 launch agimus_demo_<demo-name> bringup.launch.py robot_ip:=<robot-ip> use_rviz:=true | ||
| ``` | ||
|
|
||
| ## Running demos with Docker |
There was a problem hiding this comment.
Suggested change
| ## Running demos with Docker | |
| ## Option 1: Running demos with Docker |
kzorina
reviewed
Feb 7, 2025
|
|
||
| Now you are ready to run all of your demos! | ||
|
|
||
| ## Building dependencies from source |
There was a problem hiding this comment.
Suggested change
| ## Building dependencies from source | |
| ## Option 2: Building dependencies from source |
| Follow [these steps](doc/docker.md) to set up the docker for the project. | ||
| Agimus Demos is a set of ROS 2 packages used to launch different demos developed for [Agimus Project](https://www.agimus-project.eu/). | ||
|
|
||
| Repository is organized as set of demos with increasing complexity. Each folder contains a ROS 2 package launching the demo. README.md of each demo contains description with expected results and instruction how to launch the demo. |
There was a problem hiding this comment.
Suggested change
| Repository is organized as set of demos with increasing complexity. Each folder contains a ROS 2 package launching the demo. README.md of each demo contains description with expected results and instruction how to launch the demo. | |
| The repository is organized as set of demos with increasing complexity. | |
| Each folder contains a ROS 2 package launching the demo. | |
| The `README.md` file of each demo contains a detailed description of the expected results and instruction on how to launch the demo. |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.