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

chore: Update README for Installation, Usage and Development #58

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

kienvo
Copy link
Member

@kienvo kienvo commented Oct 7, 2024

This will close #51

Summary by Sourcery

Update the README to include comprehensive instructions for installation, usage, and development, enhancing the documentation for users and developers.

Documentation:

  • Add detailed installation instructions for setting up the firmware, including prerequisites and flashing steps.
  • Include usage guidelines for transferring bitmaps over BLE, USB HID, and USB CDC ACM, and reading firmware version from the badge.
  • Provide development instructions covering tools, build process, debugging methods, and adding new BLE profiles and USB composite devices.

Copy link

sourcery-ai bot commented Oct 7, 2024

Reviewer's Guide by Sourcery

This pull request updates the README.md file to include comprehensive information on installation, usage, and development of the BadgeMagic firmware. It adds detailed instructions for flashing the firmware, using the badge over BLE and USB, reading firmware versions, and provides guidance for developers on building, debugging, and extending the firmware functionality.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added installation instructions
  • Included steps to install wchisp
  • Provided instructions for downloading prebuilt binaries
  • Explained how to enter bootloader mode
  • Added command to flash the firmware
README.md
Expanded usage documentation
  • Added information on transferring bitmaps over BLE
  • Described USB HID data transfer method
  • Explained USB CDC ACM data transfer method
  • Provided instructions for reading firmware version via BLE, USB, and screen
README.md
Added development setup and instructions
  • Listed required development tools
  • Provided build instructions for different badge versions
  • Explained how to flash the firmware during development
  • Added debugging instructions for UART and USB CDC-ACM
README.md
Included guidance for extending firmware functionality
  • Explained how to add a new BLE profile
  • Provided instructions for adding a new USB Composite Device
README.md

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.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a 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. You can also use
    this command to specify where the summary should be inserted.

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

@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
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 2 issues found

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.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@kienvo kienvo requested a review from fcartegnie October 7, 2024 02:08
@mariobehling mariobehling merged commit 321677c into fossasia:master Oct 8, 2024
2 checks passed
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.

Create a installation howto
2 participants