ros-tooling / cross_compile

A tool to build ROS and ROS2 workspaces for various targets

Apache License 2.0

188 stars 60 forks source link

Update README documentation so installation reflects current state of project. #55

Closed zmichaels11 closed 4 years ago

zmichaels11 commented 4 years ago

Changes

Simplified Prerequisites steps
- Remove unnecessary apt installs
- Use apt instead of apt-get
Simplified Installing from source steps
- Use ros2run from cross_compile workspace
- Add a comment that the required ros2cli tooling can be sourced elsewhere on the host.
Simplified usage steps
- build the required structure as a single step
- use curl instead of wget since curl is used earlier in the document.

Signed-off-by: Zachary Michaels zmichaels11@gmail.com

codecov[bot] commented 4 years ago

Codecov Report

Merging #55 into master will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master      #55   +/-   ##
=======================================
  Coverage   63.56%   63.56%           
=======================================
  Files           4        4           
  Lines         269      269           
=======================================
  Hits          171      171           
  Misses         98       98

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 7e272a1...eef6e50. Read the comment docs.

prajakta-gokhale commented 4 years ago

What is the reason for changing apt-get to apt?

We changed the Dockerfile to use apt-get instead of apt because apt-get has more stable interface. See https://github.com/ros-tooling/cross_compile/pull/40#issuecomment-547782147 for details.

zmichaels11 commented 4 years ago

What is the reason for changing apt-get to apt?

apt is a more human-friendly tool and the instructions in the README.md are meant to be entered by a human.