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 readme #5

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme #5

wants to merge 1 commit into from

Conversation

kienvo
Copy link
Member

@kienvo kienvo commented Nov 4, 2024

Update readme and add some preview images.

Summary by Sourcery

Documentation:

  • Enhance the README with detailed information about the Badge Magic LED casing design files, related repositories, purchasing options, and tools used.

Copy link

sourcery-ai bot commented Nov 4, 2024

Reviewer's Guide by Sourcery

The PR enhances the repository's README.md by adding comprehensive documentation about the Badge Magic LED casing project. The changes include adding sections for related repositories, purchasing information, required tools, and visual documentation through rendered and actual product images.

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

File-Level Changes

Change Details Files
Added comprehensive documentation sections to the README
  • Added links to related Badge Magic repositories (firmware, hardware, Android app)
  • Included purchasing information with link to FOSSASIA Shop
  • Listed FreeCad as the required tool for working with the design files
  • Added project description identifying the repository's purpose
README.md
Added visual documentation with product images
  • Included rendered images showing front and back views
  • Added photos of the actual printed case with PCB in assembled and disassembled states
README.md
docs/images/front-rendered.png
docs/images/back-rendered.png
docs/images/case-with-pcb-disassembled.jpg
docs/images/case-with-pcb.jpg

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 - here's some feedback:

Overall Comments:

  • There are a couple of minor text issues to fix: 'Redered' should be 'Rendered' in the image section headers, and 'get a the board' should be 'get the board' in the Buy Device section.
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
## Images

### Redered image
Copy link

Choose a reason for hiding this comment

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

issue (documentation): Fix typo: 'Redered' should be 'Rendered'

README.md Outdated
## Buy Device

You can get a the board at the [FOSSASIA Shop](https://fossasia.com).
Copy link

Choose a reason for hiding this comment

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

issue (documentation): Remove redundant article 'a' in sentence

@kienvo kienvo marked this pull request as ready for review November 4, 2024 09:20
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.

## Buy Device

You can get a board at the [FOSSASIA Shop](https://fossasia.com).
Copy link

Choose a reason for hiding this comment

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

suggestion (documentation): Consider providing a more specific shop link

The current link is to the main website. A direct link to the product page would be more helpful for users looking to purchase.

Suggested change
You can get a board at the [FOSSASIA Shop](https://fossasia.com).
You can get a board at the [FOSSASIA Shop](https://shop.fossasia.com/collections/pslab).

## Tools

[FreeCad](https://www.freecad.org/downloads.php)
Copy link

Choose a reason for hiding this comment

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

nitpick (documentation): Fix capitalization of FreeCAD

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.

1 participant