diff --git a/docs/assets/img/getting_started_pics/faces/faces_quick_start_05.png b/docs/assets/img/getting_started_pics/faces/faces_quick_start_05.png new file mode 100644 index 00000000..7d8d269e Binary files /dev/null and b/docs/assets/img/getting_started_pics/faces/faces_quick_start_05.png differ diff --git a/docs/assets/img/getting_started_pics/faces/faces_quick_start_06.png b/docs/assets/img/getting_started_pics/faces/faces_quick_start_06.png new file mode 100644 index 00000000..e13ab27e Binary files /dev/null and b/docs/assets/img/getting_started_pics/faces/faces_quick_start_06.png differ diff --git a/docs/assets/img/getting_started_pics/faces/faces_quick_start_07.png b/docs/assets/img/getting_started_pics/faces/faces_quick_start_07.png new file mode 100644 index 00000000..59c57325 Binary files /dev/null and b/docs/assets/img/getting_started_pics/faces/faces_quick_start_07.png differ diff --git a/docs/assets/img/getting_started_pics/faces/faces_quick_start_08.png b/docs/assets/img/getting_started_pics/faces/faces_quick_start_08.png new file mode 100644 index 00000000..a712f0d9 Binary files /dev/null and b/docs/assets/img/getting_started_pics/faces/faces_quick_start_08.png differ diff --git a/docs/assets/img/getting_started_pics/faces/unpack_firmware.png b/docs/assets/img/getting_started_pics/faces/unpack_firmware.png index 44ddd471..3a0ad6e6 100644 Binary files a/docs/assets/img/getting_started_pics/faces/unpack_firmware.png and b/docs/assets/img/getting_started_pics/faces/unpack_firmware.png differ diff --git a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md index 29332f83..8ed73b8d 100644 --- a/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/en/quick_start/faces/gameboy_burn_a_nes_game.md @@ -12,23 +12,50 @@ ## Download firmware -Download the gameboy simulator firmware named `firmware.zip` from [Github](https://github.com/m5stack/M5Stack-nesemu). And unpack `firmware.zip`. +Download the gameboy simulator firmware named `firmware.zip` from [Github](https://github.com/m5stack/M5Stack-nesemu). And unzip `firmware.zip`. - + +### Windows OS +### Mac OS + + ## Burn Game file -Open Flash Download Tools[点击下载](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar) apply by Espressif, choose `ESP32 DownloadTool` option, choose 4 files, and execute **step 2-4** ( *choose firmware file, your serial port, erase and program flash* ) +### Windows OS + +Open Flash Download Tools[点击下载](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar) apply by Espressif, choose `ESP32 DownloadTool` option, choose 4 files, and execute those operations as the following pictures shown. ( *choose firmware file, your serial port, erase and program flash* ) - +### Mac OS + +#### (1) install esptool + +Open `terminal`, execute this command `pip install esptool` + + + +#### (2) burn the game firmware + +Open `terminal`, go to the path where `firmware.zip` is located + +Execute the following commands in the `terminal` + +```sh +unzip firmware.zip +cd firmware +esptool.py erase_flash +sh flash.sh +``` + + ## Reset you device diff --git a/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md b/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md index 1d920891..2adf83fc 100644 --- a/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md +++ b/docs/zh_CN/quick_start/faces/gameboy_burn_a_nes_game.md @@ -1,6 +1,6 @@ -# 烧录GameBoy游戏 {docsify-ignore-all} +# 烧录 NES 游戏 {docsify-ignore-all} -*这篇文档将引导你如何烧录游戏模拟器，并烧录想用的经典游戏，这样你就可以使用FACES Kit来玩GameBoy游戏。* +*这篇文档将引导你如何烧录游戏模拟器，并烧录想用的经典游戏，这样你就可以使用 FACES Kit 来玩 GameBoy 游戏。* ## 目录 @@ -8,34 +8,60 @@ 2. [烧录固件和游戏文件](#烧录固件和游戏文件) -3. [重启FACES](#重启FACES) +3. [重启 FACES](#重启-FACES) ## 下载固件 -下载Gameboy模拟器，固件名为`firmware.zip`，下载地址：[Github](https://github.com/m5stack/M5Stack-nesemu)， 然后解压`firmware.zip`(*包括启动文件bootloader.bin,分区表文件, 模拟器文件, 游戏文件SuperMario*)。 +下载 Gameboy 模拟器，固件名为 `firmware.zip`，下载地址：[Github](https://github.com/m5stack/M5Stack-nesemu)， 然后解压 `firmware.zip` (*包括启动文件bootloader.bin,分区表文件, 模拟器文件, 游戏文件SuperMario*)。 + - - +### Windows OS +### Mac OS + + + ## 烧录固件和游戏文件 -打开乐鑫提供的烧录工具[Flash Download Tools](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar)，选择 `ESP32 DownloadTool` 选项，选择`firmware.zip`解压后的四个文件，并执行如下图的**步骤2-4**( *选择正确的串口号，擦除flash和烧录固件* ) +### Windows OS + +打开乐鑫提供的烧录工具 [Flash Download Tools](https://www.espressif.com/sites/default/files/tools/flash_download_tools_v3.6.4.rar)，选择 `ESP32 DownloadTool` 选项，选择`firmware.zip`解压后的四个文件，并执行如下图的**步骤 2-4** ( *选择正确的串口号，擦除 flash 和烧录固件* ) +### Mac OS -## 重启FACES +#### (1) 安装 esptool -重启FACES之后，这时候就可以玩游戏啦。 +打开终端，执行 `pip install esptool` + + + +#### (2) 烧录固件 + +在终端，进入 `firmware.zip` 所在的路径下，执行以下命令 + +```sh +unzip firmware.zip +cd firmware +esptool.py erase_flash +sh flash.sh +``` + + + +## 重启 FACES + +重启 FACES 之后，这时候就可以玩游戏啦。 -?> Tip *如果你想换另一个游戏，只需替换**游戏文件**，再用以上工具烧录即可。注意是要使用NES格式的游戏文件。** +?> *如果你想换另一个游戏，只需替换**游戏文件**，再用以上工具烧录即可。注意是要使用 NES 格式的游戏文件。**