Skip to content

Add a checklist for the board setup #16

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

IAmMarcelJung
Copy link
Collaborator

This adds a checklist for the board setup and also fixes some minor issues in the docs such as:

  • Improve the help message of the baudrate parameter in board.py
  • Fix the alert in software/README.md so it is displayed correctly
  • Add the fabric directory in software/README.md

@usman1515
Copy link

when running the command: ./board.py upload --help remove the ) at the end of the reset flag.

-r, --reset RESET     Specify if the device should be reset. Defaults to False).

@usman1515
Copy link

LGTM now.

@IAmMarcelJung
Copy link
Collaborator Author

After revisiting this, I'm actually not sure if the checklist even belongs here, since this is more a concern of the chip testing, although having the correct firmware is still necessary. What do you think?

Copy link

@usman1515 usman1515 left a comment

Choose a reason for hiding this comment

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

I think for the time being it's fine. As we incorporate more changes we can change it accordingly.

@IAmMarcelJung IAmMarcelJung added the documentation Improvements or additions to documentation label May 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants