Skip to content

Commit 7f1fc68

Browse files
committed
update documentation
1 parent 109e240 commit 7f1fc68

14 files changed

+22
-478
lines changed

CHANGELOG.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/en/02-Flash-Firmware.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You need to connect the 3.3 Volt, GND, SWDIO and SWDCLK leads. you can use the
1717

1818
You can also use OpenOCD to flash the device, this is an example of the command to execute:
1919
```
20-
openocd -f interface/cmsis-dap.cfg -c "transport select swd" -f target/nrf52.cfg -d2 -c init -c "reset init" -c halt -c "nrf5 mass_erase" -c "program pixjs_all. hex verify" -c "program nrf52832_xxaa.hex verify" -c exit
20+
openocd -f interface/cmsis-dap.cfg -c "transport select swd" -f target/nrf52.cfg -d2 -c init -c "reset init" -c halt -c "nrf5 mass_erase" -c "program pixjs_all.hex verify" -c "program nrf52832_xxaa.hex verify" -c exit
2121
```
2222
After first flash is completed, subsequent firmware updates can be done via OTA.
2323

docs/en/03-Build-Firmware.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,22 @@
22

33
## Build with Github Actions
44

5-
TODO
5+
You could download the latest develop build from Github Actions
6+
67
https://github.com/impeeza/pixl.js/actions/workflows/pixl.js-fw.yml
78

89

910
## Build with customized Docker image
1011

12+
You could build the firmware using customized Docker image.
13+
14+
```
15+
docker run -it --rm solosky/nrf52-sdk:latest
16+
root@b10d54636088:/builds# git clone https://github.com/solosky/pixl.js
17+
root@b10d54636088:/builds# cd pixl.js
18+
root@b10d54636088:/builds/pixl.js# git submodule update --init --recursive
19+
root@b10d54636088:/builds/pixl.js# cd fw && make all
20+
root@b10d54636088:/builds/pixl.js/fw# cd application && make full ota
21+
```
22+
23+
The firmware is fw/_build/pixjs_all.hex,ota package is fw/_build/pixjs_ota_vXXXX.zip

docs/en/05+3-amiidb.md

Lines changed: 0 additions & 201 deletions
This file was deleted.
File renamed without changes.
File renamed without changes.

docs/en/README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ This fork is divided in two main sections, Hardware and Firmware
1919

2020
# Firmware
2121

22-
- A guide to [Flash the Firmware](02-Flash-Firmware "Flash the Firmware")
23-
- To help on the internationalization of the Firmware you can follow the [Guide](https://github.com/solosky/pixl.js/blob/develop/fw/docs/translation.md).
24-
- [Building the firmware](03-Build-Firmware)
22+
- A guide to [Flash the Firmware](02-Flash-Firmware.md "Flash the Firmware")
23+
- To help on the internationalization of the Firmware you can follow the [Guide](05+5-translation.md).
24+
- [Building the firmware](03-Build-Firmware.md)
2525
- [Using the firmware](04-Using-Firmware.md)
2626

2727

@@ -39,7 +39,6 @@ This fork is divided in two main sections, Hardware and Firmware
3939

4040
- [Bluetooth BLE File Transfer protocol](05+1-ble_protocol.md)
4141
- [AmiiboLink BLE Protocol](05+2-amiibolink_ble.md)
42-
- [Amiibo Database Doc.](05+3-amiidb.md)
4342
- [video player](05+4-video_player.md) (Retired on Firmware 2.5.2 due to flash size restrictions.
4443

4544

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)