Skip to content

Commit 998ee1c

Browse files
authored
Add README for Badgeware contributions
Added instructions for downloading and contributing apps to Badgeware.
1 parent 8008644 commit 998ee1c

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Badgeware Contributions
2+
3+
This repo is the home for **extra** Badgeware apps - community contributions and a few of our own that didn't quite fit into the shipping firmware. If you're looking for inspiration or if you've built a cool app and want to share it with other badgeware users, you're in the right place!
4+
5+
If you're looking for the shipping firmware and examples, you can find them at the links below:
6+
7+
- [Badger 2350](https://github.com/pimoroni/badger2350)
8+
- [Tufty 2350](https://github.com/pimoroni/tufty2350)
9+
- [Blinky 2350](https://github.com/pimoroni/blinky2350)
10+
11+
If you want to learn more about Badgeware (or would like to buy a badge of your own) check out [badgewa.re](https://badgewa.re/)!
12+
13+
## How to download an app to your badge
14+
15+
1) Download this repo (either via `git clone https://github.com/pimoroni/badgeware-contrib` or by clicking the dropdown on the 'Code' button on the front page, and clicking 'Download ZIP')
16+
2) Double press the 'RESET' button on your badge to put it into Disk Mode
17+
3) Find the app you want in the downloaded repo
18+
4) Copy the directory into the 'apps' directory on the BADGER/TUFTY/BLINKY drive.
19+
5) Eject the badge from your computer once the files have finished copying
20+
6) The new app should now be showing in the launcher.
21+
22+
## How to add a new app to this repo
23+
24+
1) Fork this repo
25+
2) Create a new directory in your fork for your app
26+
3) Add your app `__init__.py` to the directory. Don't forget to include a 24x24 icon for the launcher!
27+
4) Submit a Pull Request back to this repo
28+
5) Make more apps! 🎉

0 commit comments

Comments
 (0)