From 7d7a283b61d8f1bf0aeceb7e48a1130ab366a457 Mon Sep 17 00:00:00 2001 From: Astra <93453568+Astrrra@users.noreply.github.com> Date: Tue, 8 Aug 2023 16:57:39 +0900 Subject: [PATCH] [FL-3475] Fix markdown for descriptions (#14) --- avr_isp_programmer/.catalog/README.md | 18 +++++++----------- hid_app/.catalog/README_BLE.md | 22 ++++++++++------------ hid_app/.catalog/README_USB.md | 18 ++++++++---------- spi_mem_manager/.catalog/README.md | 8 ++++---- 4 files changed, 29 insertions(+), 37 deletions(-) diff --git a/avr_isp_programmer/.catalog/README.md b/avr_isp_programmer/.catalog/README.md index ce98e2c9438..83ea269dd62 100644 --- a/avr_isp_programmer/.catalog/README.md +++ b/avr_isp_programmer/.catalog/README.md @@ -21,34 +21,30 @@ FLIPPER PIN | AVR PIN 11 | GND 12-18 | - -## Features +# Features -### Dump +## Dump The Dump feature allows you to dump the contents of the microcontroller's flash memory to a file on your Flipper Zero's SD card. Along with the EEPROM memory, the dump files include the fuses and lock bits of the microcontroller. This can be used to backup the contents of the microcontroller's flash memory, or to extract the firmware from a device. -### Flash +## Flash The Flash feature allows you to flash the contents of a file on your Flipper Zero's SD card to the microcontroller's flash memory. It also flashes the fuses and lock bits of the microcontroller. This can help you quickly flash multiple devices with the same firmware, or to restore a device to its original firmware if it has been bricked. -### ISP +## ISP The ISP feature allows you to use your Flipper Zero as an ISP programmer for your desktop computer. After connecting your Flipper Zero to the AVR microcontroller, you can flash it via USB from your desktop computer using avrdude. -Example command: - -```bash -avrdude.exe -p m328p -c stk500v1 -P COMxx -U flash:r:X:\\sketch_sample.hex:i -``` +Example command: "avrdude.exe -p m328p -c stk500v1 -P COMxx -U flash:r:X:\\sketch_sample.hex:i" Where: -* `-p m328p` is the brand of your chip, -* `-P COMxx` is the com port number of the ISP programmer +* -p m328p is the brand of your chip, +* -P COMxx is the com port number of the ISP programmer ## Supported Microcontrollers diff --git a/hid_app/.catalog/README_BLE.md b/hid_app/.catalog/README_BLE.md index 281b57ddc46..135736ff7d7 100644 --- a/hid_app/.catalog/README_BLE.md +++ b/hid_app/.catalog/README_BLE.md @@ -1,24 +1,22 @@ # BLE Remote -## Overview - This application allows you to use your Flipper Zero as a HID (Human Interface Device) keyboard or mouse over Bluetooth Low Energy. It can be used to control a computer or a smartphone. -## Pairing +# Pairing -After selecting a mode, open the Bluetooth settings on your computer or smartphone and search for new devices. The Flipper Zero will appear as `Control [NAME]`, where `[NAME]` is the name of your Flipper Zero. Pair with the device and it will be ready to use. +After selecting a mode, open the Bluetooth settings on your computer or smartphone and search for new devices. The Flipper Zero will appear as "Control NAME", where "NAME" is the name of your Flipper Zero. Pair with the device and it will be ready to use. -## Modes +# Modes -### Keynote +## Keynote Use your Flipper Zero as a wireless presenter for any presentation software that supports keyboard navigation. There is also a vertical version that has the interface and controls rotated 90 degrees for easier use. -### Keyboard +## Keyboard Use your Flipper Zero as a wireless keyboard. Please note that key combinations are not supported. -### Media +## Media Media controller mode allows you to control media playback on your computer or smartphone. It supports the following commands: @@ -28,11 +26,11 @@ Media controller mode allows you to control media playback on your computer or s * Volume Up * Volume Down -### Mouse +## Mouse Use your Flipper Zero as a wireless mouse. Use the D-pad to move the cursor, and click with the OK and BACK buttons. -### TikTok Controller +## TikTok Controller Use your Flipper Zero as a wireless TikTok controller. It supports the following commands: @@ -42,10 +40,10 @@ Use your Flipper Zero as a wireless TikTok controller. It supports the following * Volume Up * Volume Down -### Mouse Clicker +## Mouse Clicker Repeatedly clicks the mouse button. The click interval can be adjusted with the UP and DOWN buttons. -### Mouse Jiggler +## Mouse Jiggler Moves your cursor slightly a few times per second. This can be used to prevent your computer from going to sleep. diff --git a/hid_app/.catalog/README_USB.md b/hid_app/.catalog/README_USB.md index 3064e02743a..70b93a6c1bc 100644 --- a/hid_app/.catalog/README_USB.md +++ b/hid_app/.catalog/README_USB.md @@ -1,20 +1,18 @@ # BLE Remote -## Overview - This application allows you to use your Flipper Zero as a HID (Human Interface Device) keyboard or mouse over USB. It can be used to control a computer or a smartphone. -## Modes +# Modes -### Keynote +## Keynote Use your Flipper Zero as a presenter for any presentation software that supports keyboard navigation. There is also a vertical version that has the interface and controls rotated 90 degrees for easier use. -### Keyboard +## Keyboard Use your Flipper Zero as a keyboard. Please note that key combinations are not supported. -### Media +## Media Media controller mode allows you to control media playback on your computer or smartphone. It supports the following commands: @@ -24,11 +22,11 @@ Media controller mode allows you to control media playback on your computer or s * Volume Up * Volume Down -### Mouse +## Mouse Use your Flipper Zero as a mouse. Use the D-pad to move the cursor, and click with the OK and BACK buttons. -### TikTok Controller +## TikTok Controller Use your Flipper Zero as a TikTok controller. It supports the following commands: @@ -38,10 +36,10 @@ Use your Flipper Zero as a TikTok controller. It supports the following commands * Volume Up * Volume Down -### Mouse Clicker +## Mouse Clicker Repeatedly clicks the mouse button. The click interval can be adjusted with the UP and DOWN buttons. -### Mouse Jiggler +## Mouse Jiggler Moves your cursor slightly a few times per second. This can be used to prevent your computer from going to sleep. diff --git a/spi_mem_manager/.catalog/README.md b/spi_mem_manager/.catalog/README.md index 4e743ca338a..ac3159b6eca 100644 --- a/spi_mem_manager/.catalog/README.md +++ b/spi_mem_manager/.catalog/README.md @@ -22,16 +22,16 @@ The SPI Memory Manager includes a wiring pinout diagram in the app. You can also | 12-17 | - | | 18 | GND | -## Features +# Features -### Read +## Read To read the contents of an SPI memory chip, connect it to your Flipper Zero and press the Read button. The chip type will be detected automatically, and, if it is supported, the contents of the chip will be read and saved to a file on your Flipper Zero's SD card. -### Erase +## Erase To erase the contents of an SPI memory chip, connect it to your Flipper Zero and press the Erase button. If the chip type is supported, the chip will be erased. -### Flash +## Flash To flash the contents of a file on your Flipper Zero's SD card to an SPI memory chip, connect it to your Flipper Zero, select the Saved menu option in the app, and select the file you want to flash. If the chip type is supported, the file will be flashed to the chip.