Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Makefile and Readme with new development experience #89

Merged
merged 1 commit into from
Jan 10, 2025

Conversation

nateinaction
Copy link
Member

@nateinaction nateinaction commented Jan 10, 2025

Summary

This PR updates the Makefile with new targets to help developers.

Running make takes the place of all of our setup instructions. It will setup the venv, download all dependencies, install the pre-commit hook.

You can also deploy to the board just by running make install

make help displays more of what you can do!

make help

Usage:
  make <target>
  help             Display this help.

Development
  download-libraries  Download the required libraries
  fmt              Lint and format files
  test             Run tests
  install          Install the project onto a connected PROVES Kit use `BOARD_MOUNT_POINT` to specify the mount point
  clean           Remove all gitignored files such as downloaded libraries and artifacts

Build
  build            Build the project, store the result in the artifacts directory

Testing

No testing required, this is a local/pipeline only change.

FYI @Mikefly123 we were talking about something like this for devs in a previous PR.

@blakejameson blakejameson self-requested a review January 10, 2025 03:37
Copy link
Contributor

@blakejameson blakejameson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ran all the commands on my device and had success. Great job Nate

@nateinaction nateinaction merged commit 8feda29 into main Jan 10, 2025
3 checks passed
@nateinaction nateinaction deleted the improve-developer-experience branch January 10, 2025 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants