Skip to content

Commit 328c1f5

Browse files
authored
Merge pull request #1 from microsoft/md_fixes
Mark down fixes
2 parents 3fb5561 + dce02d1 commit 328c1f5

File tree

1 file changed

+34
-24
lines changed

1 file changed

+34
-24
lines changed

MakeCode/README.md

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,24 @@
77
This doc gives some general information and guidance on how to get started programming the PyBadge with MakeCode.
88

99
## Contents
10+
1011
| Section | Description |
1112
|-------------------|--------------------------------------------|
12-
|[Introduction](##Introduction) | More information about the PyBadge, including what's on the board. |
13-
| [Programming with MakeCode](##Getting-a-MakeCode-program-on-the-PyBadge) | A quick overview on how to program the Pybadge with MakeCode with troubleshooting tips and resources.
14-
| [Suggested Learning Path](##Suggested-Learning-Path) | This section provides a brief curriculum with project-based resources for art, games, and sensors.
15-
13+
|[Introduction](#Introduction) | More information about the PyBadge, including what's on the board. |
14+
| [Programming with MakeCode](#Getting-a-MakeCode-program-on-the-PyBadge) | A quick overview on how to program the Pybadge with MakeCode with troubleshooting tips and resources.
15+
| [Suggested Learning Path](#Suggested-Learning-Path) | This section provides a brief curriculum with project-based resources for art, games, and sensors.
1616

1717
## Introduction
18+
1819
Congratulations, you've got yourself a PyBadge! The PyBadge is device called a *microcontroller,* a simple computer that we can program to do all sorts of fun things, like custom video games, music boxes, and more!
1920

2021
We can write instructions, called programs, for the PyBadge using Microsoft MakeCode Arcade which is a block-based coding platform similar to Scratch. Read on to learn more about the board and what you can make with it!
2122

2223
### What's on the board
23-
* Color screen display (1.8" 160x128 Color TFT Display)
24-
* 8 x Game/Control Buttons
25-
* Light sensor (on front)
24+
25+
* Color screen display (1.8" 160x128 Color TFT Display)
26+
* 8 x Game/Control Buttons
27+
* Light sensor (on front)
2628
* Buzzer mini-speaker
2729
* Triple-axis accelerometer (motion sensor)
2830
* 5 x NeoPixels (lights that can change colors!)
@@ -36,6 +38,7 @@ We can write instructions, called programs, for the PyBadge using Microsoft Make
3638
For the full list of features, [visit this site](https://www.adafruit.com/product/4200).
3739

3840
## Getting a MakeCode program on the PyBadge
41+
3942
<img src="https://github.com/microsoft/PybadgeResources/blob/main/MakeCode/assets/Arcade-ChooseHardware1.png" alt = "MakeCode Arcade choose hardware screenshot"
4043
width = 600>
4144
1. Download the program:
@@ -45,84 +48,91 @@ width = 600>
4548

4649
<img src="https://github.com/microsoft/PybadgeResources/blob/main/MakeCode/assets/PyBadgeBootMode.jpg" alt = "PyBadge bootloader mode"
4750
width = 400>
48-
1. Put the device into bootloader mode:
51+
1. Put the device into bootloader mode:
4952
* Double-tap the PyBadge reset button to get it to appear as a device on the computer, much like a USB drive.
5053
* When the board is in bootloader mode you'll see a screen similar to the above one show up.
5154
* Now that the board is in bootloader mode, you should see a BADGEBOOT drive show up on your computer. Drag the arcade game .uf2 file onto the drive.
5255
4. Once the file is copied over the board will restart and launch the program!
5356

5457
### General Resources
58+
5559
* [Navigating MakeCode Arcade](https://learn.adafruit.com/how-to-make-games-on-makecode-arcade/navigating-makecode-arcade): an overview of the MakeCode interface
5660
* [Arcade Game Maker Guide](https://arcade.makecode.com/skillmap): A multi-tutorial guide for learning how to make games in MakeCode Arcade. Includes certificates for completed tutorials.
5761

58-
5962
### Troubleshooting
63+
6064
1. Make sure you're using a data transfer USB cable (one of the most common blockers w/ hardware functioning properly).
6165
1. You may need to update the bootloader on the PyBadge, particularly if you're working on a Mac. If you notice your board is titled "ARCADE-D51" or "BADGEBOOT", [follow this tutorial](https://learn.adafruit.com/adafruit-pybadge/updating-the-bootloader).
6266
2. Troubleshooting help:
6367
- [Latest Arcade topics - Microsoft MakeCode](https://forum.makecode.com/c/Share-your-Arcade-projects-here/5)
6468
- [Adafruit customer service forums: MakeCode](https://forums.adafruit.com/viewforum.php?f=64)
6569

6670
## Suggested Learning Path
71+
6772
### Lesson 0: Test Program
68-
> Estimated time: 30 - 45 minutes.
6973

74+
> Estimated time: 30 - 45 minutes.
7075
> Recommended ages: All!
7176
72-
This lesson introduces students to MakeCode Arcade and shows them how to load MakeCode programs onto the PyBadge.
77+
This lesson introduces participants to MakeCode Arcade and shows them how to load MakeCode programs onto the PyBadge.
7378

74-
1. Start by giving students some time to explore MakeCode Arcade and create a creature or character.
75-
2. Show students how to download the program and load onto the PyBadge.
76-
3. Depending on students' experience, include 10 - 15 minutes for loading a first test program.
77-
4. If students finish early, encourage them to start adding to their test program by making the character move, adding a background, or exploring the on-board sensors.
78-
5. Encourage students to share their creations, what worked well, what was surprising, and any mysteries or questions they have.
79+
1. Start by giving participants some time to explore MakeCode Arcade and create a creature or character.
80+
2. Show participants how to download the program and load onto the PyBadge.
81+
3. Depending on participants' experience, include 10 - 15 minutes for loading a first test program.
82+
4. If participants finish early, encourage them to start adding to their test program by making the character move, adding a background, or exploring the on-board sensors.
83+
5. Encourage participants to share their creations, what worked well, what was surprising, and any mysteries or questions they have.
7984

8085
### Lesson 1: Open-ended exploration
81-
> Estimated time: 60 - 90 min, longer as needed
8286

87+
> Estimated time: 60 - 90 min, longer as needed
8388
> Recommended ages: 8+
8489
85-
Provide students an open-ended prompt and allow them to design and build a solution using MakeCode Arcade and the PyBadge.
90+
Provide participants an open-ended prompt and allow them to design and build a solution using MakeCode Arcade and the PyBadge.
8691

8792
It may be helpful to start with a short lesson on the **Design Thinking Process**. [Here's a helpful resource created by the Stanford D School](https://kissingergroup.com/wp-content/uploads/2020/06/An-Introduction-to-Design-Thinking.pdf).
8893

89-
If students are unsure what to make, suggest they write down their values, or things they care about, and use one to motivate a project.
94+
If participants are unsure what to make, suggest they write down their values, or things they care about, and use one to motivate a project.
9095

9196
**Sample prompts**
97+
9298
* Make something for someone you love
9399
* Make something inspired by nature
94100
* Design a solution for an everyday problem
95101
* Invent an instrument
96-
* Design a game (for 2 or more people)
97-
* Explore other prompts based on students' interests!
98-
102+
* Design a game (for 2 or more people)
103+
* Explore other prompts based on participants' interests!
99104

100105
### Lessons 2 and onward: Build a project!
101-
> Estimated time: 60 min
102106

107+
> Estimated time: 60 min
103108
> Recommended ages: 8+
104109
105110
#### Art & Games
111+
106112
**Beginner**
113+
107114
* Check out the tutorials in [MakeCode Arcade](https://arcade.makecode.com/)!
108115
* [Pixel Art](https://learn.adafruit.com/makecode-arcade-pixel-art-sprites): A fantastic guide to making pixel art in MakeCode Arcade.
109116
* [Name Badge](https://learn.adafruit.com/making-a-name-tag-in-makecode-arcade/starting-your-name-tag): Make a custom name badge!
110117
* [Sparky Invaders](https://learn.adafruit.com/makecode-arcade-sparky-invaders): Learn how to make a game inspired by Space Invaders!
111118

112119
**Intermediate to Advanced**
120+
113121
* [Making Platform Games](https://learn.adafruit.com/makecode-arcade-platform-level): learn how to make scrolling platformer games like Super Mario Bros for NES!
114122
* [Re-Making Classics: Arkanoid](https://learn.adafruit.com/re-makecode-the-classics-arkanoid): A tutorial showing you the logic and blocks for making the classic Arkanoid game.
115123
* [my lil' ai](https://youtu.be/kNZUletw9lg): A digital pet that teaches the basics of machine learning (ML), or AI.
116124
* [Adding features to games](https://learn.adafruit.com/next-level-makecode-arcade-games): Learn how to enhance graphics, add background music, and use neopixels to track in-game stats.
117125
* [Adding custom color palettes](https://learn.adafruit.com/custom-color-palettes-for-makecode-arcade-games): Learn how to add custom color palettes to MakeCode Arcade.
118126

119127
#### Sensors and Beyond!
128+
120129
**Beginner**
130+
121131
* [PyBadge Plant Monitor](https://learn.adafruit.com/plantagotchi-pybadge-plant-monitor): Using just the PyBadge (and a plant on-hand), program a plant monitor in MakeCode Arcade.
122132
* [Marble Labyrinth Game](https://learn.adafruit.com/pygamer-marble-labyrinth-in-makecode-arcade): Use the accelerometer to simulate a marble labyrinthe maze game.
123133
* [Digital Sand](https://learn.adafruit.com/pixeldust-digital-sand-demos-for-arcada): Learn how to create motion-activated effects for the PyBadge
124134

125135
**Intermediate to Advanced**
136+
126137
* [Sensors in MakeCode](https://learn.adafruit.com/sensors-in-makecode): Learn how to use sensors in MakeCode!
127138
* (Note: this tutorial focuses on the Circuit Playground Express but may be adapted for the PyBadge)
128-

0 commit comments

Comments
 (0)