Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
csBlueChip authored Aug 17, 2022
1 parent d6a5623 commit 2af63dd
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,49 @@
# FlipperZero_plugin_howto
A simple plugin for the FlipperZero written as a tutorial example [ie. excessive documentation & error handling]

# If you have not yet installed the FlipperZero devkit
```
mkdir -p ~/flipperZero/official/
cd ~/flipperZero/official/
git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git ./
./fbt
```
...and wait while it downloads all the required tools and performs the first build of the code.

# After the devkit is installed
Assuming your devkit is in: `~/flipperZero/official/`<br/>
...checkout this demo with:
```
cd ~/flipperZero/official//applications
mkdir bc_demo
cd bc_demo
git clone https://github.com/csBlueChip/FlipperZero_plugin_howto.git ./
```

# After bc_demo is downloaded
Compile with:
```
cd ~/flipperZero/official/
./fbt
```
...And/Or (Compile and) Flash with:
```
cd ~/flipperZero/official/
./fbt flash_usb
```
...Flashing will fail if the FlipperZero is running an app/plugin!

# About the bc_demo code & documentation
* Review the `README.txt` file for an overview of the code, and how to get started.
* Take a look in `bc_demo.c` for, frankly, an abusive amount of commenting; and overkill error-handling.

The code is all M.I.T. Licensed ...take it ...use it ...butcher it ...polish it ...whatever. <br/>
...If you do anything cool with it, I'd love to see your creation :)

# Compiling the demo
You will need to add bc_demo to the system menu by editing `~/flipperZero/official//applications/meta/application.fam` in accordance with the intructions in `README.txt (Plugins) #2`<br>
...then simply use the same compile & flash command we used previously:
```
cd ~/flipperZero/official/
./fbt flash_usb
```

0 comments on commit 2af63dd

Please sign in to comment.