Update README and re-write some sections

[christophebedard]

This makes various small changes to the README:

• fix codecov example/snippet
  • fixes Codecov in action-ros-ci does not work #562
  • codecov.yaml seems to have been renamed to codecov.yml
  • actions/checkout is needed for codecov/codecov-action to get codecov.yml
  • update/fix codecov.yml example
  • mention needing to provide CODECOV_TOKEN only for private repos
  • update codecov/codecov-action version
  • use 'coverage-pytest' mixin in snippet too
• add table of contents for an easy overview of the README
• split ament_copyright basic example into binary vs source build
  • this makes it obvious to users that there are 2 ways of using the action
  • use a generic package name instead of ament_copyright
• uniformize snippets
  • remove use of actions/checkout when not needed
  • add steps: where needed so that snippets are complete-ish examples
• fix use of if: always() in logs upload example
• update commit used for colcon-mixin-repository
• add codecov badge
• make small fixes & rephrase & uniformize
• move 'Developing' section to the bottom
  • since this does not really apply to most people looking at the README

Signed-off-by: Christophe Bedard bedard.christophe@gmail.com

[codecov]

Codecov Report

Merging #568 (75bf3e6) into master (07b0bef) will decrease coverage by 0.93%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #568      +/-   ##
==========================================
- Coverage   39.90%   38.96%   -0.94%     
==========================================
  Files           2        2              
  Lines         213      213              
  Branches       39       39              
==========================================
- Hits           85       83       -2     
- Misses        128      130       +2     

Impacted Files	Coverage Δ
src/action-ros-ci.ts	29.34% <0.00%> (-1.09%)	⬇️

---

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 07b0bef...a48a649. Read the comment docs.

[christophebedard]

The dependabot badge seems broken. See dependabot/dependabot-core#1912 & dependabot/dependabot-core#1960.

[emersonknapp]

This looks great, thanks for the updates!

[christophebedard]

We might want to wait until #570 is merged so that I can rebase on it and update the table of contents to add the new section from that PR.

Oh wait I can just add it now and see if there are any conflicts.

[emersonknapp]

We might want to wait until #570 is merged so that I can rebase on it and update the table of contents to add the new section from that PR.

Oh wait I can just add it now and see if there are any conflicts.

I've enabled auto-merge on all of these PRs - they won't merge until they are up-to-date, pass tests, and have no merge conflicts - so you should have complete control over the order of operations now by updating branches in your chosen order