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

Merged
merged 1 commit into from
Feb 3, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# badgemagic-case
# badgemagic-case

This repository contains the [Badge Magic](https://badgemagic.fossasia.org) LED
casing design files.

## Related Repositories

- Firmware: <https://github.com/fossasia/badgemagic-firmware>
- Hardware: <https://github.com/fossasia/badgemagic-hardware>
- Android app: <https://github.com/fossasia/badgemagic-android>
- And [other repositories](https://github.com/fossasia/?q=badgemagic).

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


## Images

### Rendered image

![](docs/images/front-rendered.png)

![](docs/images/back-rendered.png)

### Printed case

Printed case with resin printer:

![](docs/images/case-with-pcb-disassembled.jpg)

![](docs/images/case-with-pcb.jpg)

![](docs/images/case.pcb.cover.jpg)
Binary file added docs/images/back-rendered.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/case-with-pcb-disassembled.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/case-with-pcb.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/case.pcb.cover.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/front-rendered.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.