Skip to content

chore: update readme for shorting instruction#89

Merged
Jhalakupadhyay merged 1 commit intofossasia:masterfrom
kienvo:shorting-instruction
Jun 4, 2025
Merged

chore: update readme for shorting instruction#89
Jhalakupadhyay merged 1 commit intofossasia:masterfrom
kienvo:shorting-instruction

Conversation

@kienvo
Copy link
Copy Markdown
Member

@kienvo kienvo commented Jun 4, 2025

How to flash without a soldering iron.

Summary by Sourcery

Update README to improve flashing instructions without soldering by adding an alternative C3 shorting method, a dmesg verification step, and an illustrative diagram asset.

Documentation:

  • Add alternative ISP entry method by shorting the C3 capacitor instead of disconnecting the battery
  • Add instructions to verify ISP mode via dmesg output (idVendor=4348, idProduct=55e0)
  • Include burn-badge.svg diagram asset to illustrate the shorting procedure

@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai Bot commented Jun 4, 2025

Reviewer's Guide

Extended README flashing instructions to provide two methods for entering the bootloader (battery‐disconnect or C3 capacitor short) and added a visual asset to illustrate the process.

File-Level Changes

Change Details Files
Enhanced bootloader entry instructions with alternative shorting method
  • Replaced single battery-disconnect approach with two bootloader-entry options
  • Added steps to short and release C3 capacitor while holding KEY2
  • Guided user to verify ISP mode via dmesg with idVendor/idProduct
README.md
Introduced visual diagram for flashing process
  • Added burn-badge.svg asset
  • Embedded the image reference into the flashing instructions
assets/burn-badge.svg
README.md

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey @kienvo - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Member

@samruddhi-Rahegaonkar samruddhi-Rahegaonkar left a comment

Choose a reason for hiding this comment

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

Yes, it’s working. I’ve tested it successfully.

@Jhalakupadhyay Jhalakupadhyay merged commit ac64530 into fossasia:master Jun 4, 2025
2 checks passed
@nope3472
Copy link
Copy Markdown

nope3472 commented Jun 4, 2025

I have not recieved the badge yet so i cant test it from my side.

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.

4 participants