Skip to content

Update README for mpremote and package usage#35

Merged
brainelectronics merged 3 commits intomainfrom
feature/improve-docs
Apr 14, 2026
Merged

Update README for mpremote and package usage#35
brainelectronics merged 3 commits intomainfrom
feature/improve-docs

Conversation

@brainelectronics
Copy link
Copy Markdown
Owner

This change updates the manual package installation instructions to use mpremote over rshell.

In the PyPI section the usage of twine check before twine upload is recommended.

An example instruction on how to install a specific version with upip was added.

The package usage example and the corresponding main.py example files are extended to set the LED pin based on the board extracted from os.uname().

@brainelectronics brainelectronics self-assigned this Apr 14, 2026
@brainelectronics brainelectronics added the documentation Improvements or additions to documentation label Apr 14, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Apr 14, 2026

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (8e84bbb) to head (bcaf260).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #35   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines           11        11           
  Branches         1         1           
=========================================
  Hits            11        11           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Owner Author

@brainelectronics brainelectronics left a comment

Choose a reason for hiding this comment

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

wonderful

@brainelectronics brainelectronics merged commit 01a7f59 into main Apr 14, 2026
6 checks passed
@brainelectronics brainelectronics deleted the feature/improve-docs branch April 14, 2026 16:22
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