liz/flipperzero-firmware
liz/flipperzero-firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix readme consistency issues (#652)

Browse Source 
* Correct notation for checked checkbox in markdown
* Cleanup image and link notation for consistency
* Syntax highlighting
* Update alt for images and fix incorrect link

Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
Nemanja Nedeljković 2021-08-17 12:38:47 +02:00 committed by GitHub
parent f02cec45a0
commit ac5c1cb4a0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ReadMe.md
View File

@ -2,14 +2,14 @@
[![Discord](https://img.shields.io/discord/740930220399525928.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](http://flipperzero.one/discord) [![Discord](https://img.shields.io/discord/740930220399525928.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](http://flipperzero.one/discord)
<img src="https://habrastorage.org/webt/eo/m0/e4/eom0e4btudte7nrhnyic-laiog0.png" /> ![Show me the code](https://habrastorage.org/webt/eo/m0/e4/eom0e4btudte7nrhnyic-laiog0.png)
Welcome to [Flipper Zero](https://flipperzero.one/)'s Firmware repo! Welcome to [Flipper Zero](https://flipperzero.one/)'s Firmware repo!
Our goal is to create nice and clean code with good documentation, to make it a pleasure for everyone to work with. Our goal is to create nice and clean code with good documentation, to make it a pleasure for everyone to work with.
# Update firmware # Update firmware
<a href="https://update.flipperzero.one/">Get Latest Firmware from Update Server</a> [Get Latest Firmware from Update Server](https://update.flipperzero.one/)
Flipper Zero's firmware consists of three components: Flipper Zero's firmware consists of three components:
@ -51,7 +51,7 @@ One liner: `./flash_core1_main.sh`
- Press and hold `← Left` + `↩ Back` for reset - Press and hold `← Left` + `↩ Back` for reset
- Release `← Left` and keep holding `↩ Back` until blue LED lights up - Release `← Left` and keep holding `↩ Back` until blue LED lights up
- Release `↩ Back` - Release `↩ Back`
<img src="https://habrastorage.org/webt/uu/c3/g2/uuc3g2n36f2sju19rskcvjzjf6w.png" /> ![Switch to DFU sequence](https://habrastorage.org/webt/uu/c3/g2/uuc3g2n36f2sju19rskcvjzjf6w.png)
1. Run `dfu-util -D full.dfu -a 0` 1. Run `dfu-util -D full.dfu -a 0`

4
assets/ReadMe.md
View File

@ -6,7 +6,9 @@
# Compiling # Compiling
make all ```bash
make all
```
# Asset naming rules # Asset naming rules

6
bootloader/ReadMe.md
View File

@ -2,9 +2,9 @@
What it does? What it does?
- [+] Hardware initialization - [x] Hardware initialization
- [+] Boot process LED indicators - [x] Boot process LED indicators
- [+] Firmware update - [x] Firmware update
- [ ] Firmware CRC check - [ ] Firmware CRC check
- [ ] Interactive UI - [ ] Interactive UI
- [ ] FS check - [ ] FS check

8
scripts/ReadMe.md
View File

@ -44,8 +44,12 @@ Also OB may be damaged, so we've made couple scripts to check and set option byt
Checking option bytes: Checking option bytes:
ob.py check ```bash
ob.py check
```
Setting option bytes: Setting option bytes:
ob.py set ```bash
ob.py set
```