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.

Sign up for GitHub

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

Badge is still evolving #41

Merged
merged 1 commit into from
May 15, 2024
Merged

Badge is still evolving #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 8 additions & 4 deletions docs/introduction/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is a short introduction containing some information and a small example meant to show how to use the badge.

**It is strongly recommended you read through this entire document.**
**It is strongly recommended that you read through this entire document.**

## Quick Badge Facts

Expand All @@ -11,7 +11,7 @@ The badge is based on the PyBadge and is equipped with:
- A 32-bit ARM CPU
- A light sensor
- A 160x128 16-bit RGB (RGB565) screen
- 5 24-bit RGB LEDs
- 5 24-bit RGB LEDs (neopixels)
- 1 red LED on the back
- A speaker
- Start/option buttons
Expand All @@ -33,7 +33,7 @@ cd docs/introduction

## The Example

See `src/hello.zig` and tweak the the values to your liking. I recommend quickly altering the `hello.zig` example a first time and following the rest of these instructions and then going back to modify it some more, if you'd like.
See `src/hello.zig` and tweak the the values to your liking.

### Running on the simulator

Expand All @@ -47,6 +47,10 @@ Once you're happy with what you've made, read on to learn how to flash your code

## Hard(ware) mode

**Please wait until the afternoon before trying to upload programs onto badges as the badge is still being worked on.**

Currently, only the neopixels are functional.

### Power and Boot

Your badge can be powered via the USB-C port, but to allow cordless use of the badge, you've been provided with a battery and two pieces of velcro.
Expand Down Expand Up @@ -75,6 +79,6 @@ You'll find a brass colored button on the back of the board, at the top. This is

Please ask someone with a staff badge (most likely Auguste) - we'd be happy to help!

If you can't locate one of us, please post in the Discord thread and we'll get back to you as fast as possible!
If you can't locate one of us, please post your question in the Discord thread and we'll get back to you as quickly as possible!

## Have fun!
Loading