Skip to content

Commit 5983227

Browse files
authored
Merge pull request #263 from Tinyu-Zhao/master
Update README
2 parents 3657238 + 99672c6 commit 5983227

File tree

2 files changed

+36
-97
lines changed

2 files changed

+36
-97
lines changed

README.md

Lines changed: 18 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,63 +2,38 @@
22

33
English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_started_ja.md)
44

5-
Welcome to program with M5Stack Core
5+
<img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/gray/gray_01.webp" alt="gray" width="350" height="350">
66

7-
## 1. Get Started
7+
<img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/basic/basic_01.webp" alt="basic" width="350" height="350">
88

9-
#### Here is the article to get started
9+
* **For the Detailed documentation of Gray, please [Click here](https://docs.m5stack.com/#/en/core/m5stickc)**
10+
*
11+
* **For the Detailed documentation of Basic, please [Click here](https://docs.m5stack.com/#/en/core/m5stickc)**
1012

11-
*1.For MacOS*
13+
* **In order to buy Basic, please [Click here](https://www.aliexpress.com/item/32837164440.html?spm=a2g0o.store_pc_groupList.8148356.11.38a9361bR9o79U)**
14+
*
1215

13-
https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS
16+
*We have several master M5Cores with different configurations, this is the difference between them [Compared](https://docs.m5stack.com/en/products_selector).*
1417

15-
*2. For Windows*
16-
17-
https://docs.m5stack.com/#/en/quick_start/m5core/m5stack_core_get_started_Arduino_Windows
18-
19-
20-
## 2. Example
21-
22-
https://github.com/m5stack/M5Stack/tree/master/examples
23-
24-
## 3. API Reference
25-
26-
https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19
27-
28-
https://docs.m5stack.com/#/en/api
29-
30-
## 4. H/W Reference
31-
32-
**LCD & TF Card**
18+
### M-BUS
19+
![image](docs/M-BUS.jpg)
3320

34-
*LCD Resolution: 320x240*
21+
## More Information
3522

36-
<table>
37-
<tr><td>ESP32 Chip</td><td>GPIO23</td><td>GPIO19</td><td>GPIO18</td><td>GPIO14</td><td>GPIO27</td><td>GPIO33</td><td>GPIO32</td><td>GPIO4</td></tr>
38-
<tr><td>ILI9341</td><td>MOSI/MISO</td><td>/</td><td>CLK</td><td>CS</td><td>DC</td><td>RST</td><td>BL</td><td> </td></tr>
39-
<tr><td>TF Card</td><td>MOSI</td><td>MISO</td><td>CLK</td><td> </td><td> </td><td> </td><td> </td><td>CS</td></tr>
40-
</table>
23+
**UIFlow Quick Start**: [PinMap](https://docs.m5stack.com/zh_CN/quick_start/m5core/uiflow)
4124

42-
**Button & Speaker**
25+
**MicroPyhton API**: [PinMap](https://docs.m5stack.com/zh_CN/mpy/display/m5stack_lvgl)
4326

44-
<table>
45-
<tr><td>ESP32 Chip</td><td>GPIO39</td><td>GPIO38</td><td>GPIO37</td><td>GPIO25</td></tr>
46-
<tr><td>Button Pin</td><td>BUTTON A</td><td>BUTTON B</td><td>BUTTON C</td></tr>
47-
<tr><td>Speaker</td><td> </td><td> </td><td> </td><td>Speaker Pin</td></tr>
48-
</table>
27+
**Arduino IDE Development**: [PinMap](https://docs.m5stack.com/zh_CN/quick_start/m5core/arduino)
4928

50-
**GROVE A**
29+
**M5StickC Arduino API**: [PinMap](https://docs.m5stack.com/zh_CN/api/system)
5130

52-
<table>
53-
<tr><td>ESP32 Chip</td><td>GPIO22</td><td>GPIO21</td></tr>
54-
<tr><td>GROVE A</td><td>SCL</td><td>SDA</td></tr>
55-
</table>
31+
**Gray PinMap**: [PinMap](https://docs.m5stack.com/zh_CN/core/gray)
5632

33+
**Basic PinMap**: [PinMap](https://docs.m5stack.com/zh_CN/core/basic)
5734

58-
### M-BUS
59-
![image](docs/M-BUS.jpg)
6035

61-
## 5. USER CASES
36+
## USER CASES
6237

6338
* [M5Stack-SD-Updater](https://github.com/tobozo/M5Stack-SD-Updater) - Customizable menu system for M5Stack - loads apps from the Micro SD
6439
card

docs/getting_started_cn.md

Lines changed: 18 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,34 @@
1-
# M5Stack
1+
# M5Stack Library
22

33
[English](../README.md) | 中文 | [日本語](getting_started_ja.md)
44

5-
## 1. 上手指南
5+
<img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/gray/gray_01.webp" alt="gray" width="350" height="350">
66

7-
*1.For MacOS*
7+
<img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/basic/basic_01.webp" alt="basic" width="350" height="350">
88

9-
https://docs.m5stack.com/#/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_MacOS
9+
* **如果查看 Gray 的详细介绍文档,[点击这里](https://docs.m5stack.com/#/zh_CN/core/gray)**
10+
*
11+
* **如果查看 Basic 的详细介绍文档,[点击这里](https://docs.m5stack.com/#/zh_CN/core/basic)**
1012

11-
*2. For Windows*
13+
* **如果想要购买 Basic 的话,[点击这里](https://item.taobao.com/item.htm?spm=a1z10.5-c-s.w4002-22404213529.15.38ea1d912Zbl0z&id=610634829528)**
14+
*
15+
*我们有几款不同配置的主控 M5Cores,这是他们之间的[对比](https://docs.m5stack.com/zh_CN/products_selector).*
1216

13-
https://docs.m5stack.com/#/zh_CN/quick_start/m5core/m5stack_core_get_started_Arduino_Windows
1417

18+
### M-BUS
19+
![image](../docs/M-BUS.jpg)
1520

16-
## 2. 例程
17-
18-
https://github.com/m5stack/M5Stack/tree/master/examples
19-
20-
## 3. API 参考
21-
22-
https://github.com/m5stack/M5Stack/blob/master/src/M5Stack.h#L19
23-
24-
https://docs.m5stack.com/#/zh_CN/api
25-
26-
## 4. H/W 参考
27-
28-
#### 管脚映射
29-
30-
*我们有几款不同配置的主控 M5Cores,这是他们之间的[对比](https://github.com/m5stack/M5-Schematic/blob/master/Core/hardware_difference_between_cores.md).*
31-
32-
**LCD & TF Card**
33-
34-
*LCD 分辨率: 320x240*
35-
36-
<table>
37-
<tr><td>ESP32 Chip</td><td>GPIO23</td><td>GPIO19</td><td>GPIO18</td><td>GPIO14</td><td>GPIO27</td><td>GPIO33</td><td>GPIO32</td><td>GPIO4</td></tr>
38-
<tr><td>ILI9341</td><td>/</td><td>MISO</td><td>CLK</td><td>CS</td><td>DC</td><td>RST</td><td>BL</td><td> </td></tr>
39-
<tr><td>TF Card</td><td>MOSI</td><td>MISO</td><td>CLK</td><td> </td><td> </td><td> </td><td> </td><td>CS</td></tr>
40-
41-
</table>
42-
43-
**Button & Speaker**
44-
45-
<table>
46-
<tr><td>ESP32 Chip</td><td>GPIO39</td><td>GPIO38</td><td>GPIO37</td><td>GPIO25</td></tr>
47-
<tr><td>Button Pin</td><td>BUTTON A</td><td>BUTTON B</td><td>BUTTON C</td></tr>
48-
<tr><td>Speaker</td><td> </td><td> </td><td> </td><td>Speaker Pin</td></tr>
49-
</table>
50-
51-
**GROVE A**
52-
53-
<table>
54-
<tr><td>ESP32 Chip</td><td>GPIO22</td><td>GPIO21</td></tr>
55-
<tr><td>GROVE A</td><td>SCL</td><td>SDA</td></tr>
56-
</table>
5721

22+
## 更多信息
5823

59-
### M-BUS
60-
![image](../docs/M-BUS.jpg)
24+
**UIFlow 快速上手**: [点击这里](https://docs.m5stack.com/zh_CN/quick_start/m5core/uiflow)
6125

62-
#### Note:
26+
**MicroPyhton API**: [点击这里](https://docs.m5stack.com/zh_CN/mpy/display/m5stack_lvgl)
6327

64-
* 如何安装 CP210x 串口驱动
28+
**Arduino IDE 环境搭建**: [点击这里](https://docs.m5stack.com/zh_CN/quick_start/m5core/arduino)
6529

66-
https://docs.m5stack.com/#/zh_CN/related_documents/establish_serial_connection
30+
**M5StickC Arduino API**: [点击这里](https://docs.m5stack.com/zh_CN/api/system)
6731

68-
* 如何升级 M5Stack 库
32+
**Gray 引脚地图**: [点击这里](https://docs.m5stack.com/zh_CN/core/gray)
6933

70-
https://docs.m5stack.com/#/zh_CN/related_documents/upgrade_m5stack_lib
34+
**Basic 引脚地图**: [点击这里](https://docs.m5stack.com/zh_CN/core/basic)

0 commit comments

Comments
 (0)