m5/m5-docs
0
0
Fork 0
mirror of https://github.com/m5stack/m5-docs.git synced 2026-05-20 10:23:01 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11 from m5stack/dev-readthedocs

Browse Source 
Dev readthedocs
This commit is contained in:
LiHuashen
2018-09-20 12:03:32 +08:00
committed by GitHub
parent 80c8c592ce e2929ef1b1
commit 2c9af43d51
5 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
en/api-reference/index.rst
+2 -7
View File
@@ -1,18 +1,13 @@
*************
API Reference
API Reference
*************
.. toctree::
:maxdepth: 1
LCD <lcd/lcd>
Button <button/button>
Peripherals <peripherals/index>
Mic <mic/mic>
Speaker <speaker/speaker>
SD Card <sd_card/sd_card>
en/get-started/how_to_burn_firmware_en.md
+3 -3
View File
@@ -1,6 +1,6 @@
# How to Burn Firmware
This article will guide you how to burn a right firmware to your board.
This article will guide you how to burn a right firmware to your board via M5Burner.
### For MacOS
@@ -16,7 +16,7 @@ For downloading M5Burner, visit the [offical website](http://www.m5stack.com) pl
#### 2. Burn the firmware
Unpack the M5Burner tool which you donwloaded for official website just now in any folder, then execute the executable file `M5Burner.exe`.
Unzip the M5Burner tool which you donwloaded for official website just now, then double click `M5Burner.exe`.
![image](../../_static/getting_started_pics/burn_firmware_01.png)
@@ -27,7 +27,7 @@ Unpack the M5Burner tool which you donwloaded for official website just now in a
**1. Choice a right firmware**
a. select `M5Flow-vx.x` option, if you want to program with [M5Flow](http://flow.m5stack.com)
a. select `M5Flow-vx.x` option(the lastest version), if you want to program with [M5Flow](http://flow.m5stack.com)
b. select `M5Cam-vx.x (/M5Cam-psram)` option, if you own a ESP32CAM (/ M5CAMERA)
en/get-started/how_to_burn_firmware_en.rst
+3 -4
View File
@@ -1,7 +1,7 @@
How to Burn Firmware
====================
This article will guide you how to burn a right firmware to your board.
This article will guide you how to burn a right firmware to your board via M5Burner.
For MacOS
---------
@@ -22,8 +22,7 @@ website <http://www.m5stack.com>`__ please.
2. Burn the firmware
::::::::::::::::::::
Unpack the M5Burner tool which you donwloaded for official website just
now in any folder, then execute the executable file ``M5Burner.exe``.
Unzip the M5Burner tool which you donwloaded for official website just now, then double click ``M5Burner.exe``.
.. image:: ../../_static/getting_started_pics/burn_firmware_01.png
@@ -41,7 +40,7 @@ If only ``COM1`` exists at the option, you need to visit this article `establish
a. Choice a right firmware
"""""""""""""""""""""""""""
a. select ``M5Flow-vx.x`` option, if you want to program with
a. select ``M5Flow-vx.x`` option(the lastest version), if you want to program with
`M5Flow <http://flow.m5stack.com>`__
b. select ``M5Cam-vx.x (/M5Cam-psram)`` option, if you own a ESP32CAM (/
en/product-documents/accessorries/headers_socket.rst
+5
View File
@@ -0,0 +1,5 @@
Headers Socket
========================
DESCRIPTION
-----------
en/product-documents/index.rst
+2 -1
View File
@@ -46,7 +46,8 @@ ACCESSORY
.. toctree::
:maxdepth: 1
cable <cables/cable>
cable <accessorries/cables/cable>
Headers Socket <accessorries/headers_socket>
UNIT
~~~~~~~~~~~~~~~~~~~