Przeglądaj źródła

README improvements.

Aaron Mavrinac 2 lat temu
rodzic
commit
fa92d2be59
3 zmienionych plików z 12 dodań i 6 usunięć
  1. 12 6
      README.md
  2. BIN
      img/screenshot.png
  3. BIN
      ui.png

+ 12 - 6
README.md

@@ -1,14 +1,20 @@
 # BPM Tapper
 
+[![FAP Build](https://github.com/ezod/flipperzero-bpm-tapper/actions/workflows/build.yml/badge.svg)](https://github.com/ezod/flipperzero-bpm-tapper/actions/workflows/build.yml)
+
 A BPM Tapper for the Flipper Zero.
 
-![screenshot](img/screenshot.png)
+![ui](ui.png)
 
-Hit any button other than back repeatedly. Calculates based on the average of the last 8 inputs.
+## Installation
 
-## Compiling
+1. Navigate to the [FAP Build](https://github.com/ezod/flipperzero-bpm-tapper/actions/workflows/build.yml)
+   GitHub action workflow, and select the most recent run.
+2. The FAP is built for both the `dev` and `release` channels of the official
+   firmware. Download the artifact corresponding to your firmware version.
+3. Extract `bpm_tapper.fap` from the ZIP file to `apps/Music` on your Flipper
+   Zero SD card.
 
-```
-./fbt fap_bpm_tapper
-```
+## Usage
 
+Hit any button other than back repeatedly. Calculates based on the average of the last 8 inputs.

BIN
img/screenshot.png


BIN
ui.png