From 2af63ddcc2cc057de566e2e7dba546236c59f9a4 Mon Sep 17 00:00:00 2001 From: BlueChip Date: Wed, 17 Aug 2022 21:44:20 +0100 Subject: [PATCH] Update README.md --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/README.md b/README.md index 7c092f5..6a0ddec 100644 --- a/README.md +++ b/README.md @@ -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/`
+...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.
+...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`
+...then simply use the same compile & flash command we used previously: +``` +cd ~/flipperZero/official/ +./fbt flash_usb +```