search

macformula / racecar

Monorepo for all firmware running on our custom ECU's
6 stars 1 forks source link

Replace Makefile with Task? #151

Open BlakeFreer opened 1 month ago

BlakeFreer commented 1 month ago

Our firmware build system is orchestrated by firmware/Makefile. While this works, it is an improper use of Makefile since we using it to run commands in sequence rather than compile targets from prerequisites (which we delegate to CMake).

I came across Task https://taskfile.dev/ which claims to be an alternative and may be a more appropriate tool.

Your task is to:

  1. Write firmware/Taskfile.dist.yml to replicate the functionality of our Makefile. The command line interface does not need to be exactly the same but the user should be able to specify the action (build / st-flash / config / clean), project and platform.

    See https://taskfile.dev/usage/#supported-file-names for an explanation of the .dist component of the filename.

  2. In your PR, write your observations about Task vs Make.

    • How easy was it to learn vs Makefile?
    • Do you think it is a better tool? How was the installation of the Task program.
    • Do you think it will evolve well with our repository?

  3. Add installation instructions to docs/docs/firmware/dev-setup.md. See instruction for adding docs