From fd06be9d77a33ea2971be76cd94565cc09df18e4 Mon Sep 17 00:00:00 2001 From: Shinichi Ohki Date: Wed, 24 Oct 2018 20:15:02 +0900 Subject: [PATCH 1/3] Fix URL String. --- docs/product_documents/m5stack-core/m5core_gray.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/product_documents/m5stack-core/m5core_gray.md b/docs/product_documents/m5stack-core/m5core_gray.md index c0d8a02c..44105a1c 100644 --- a/docs/product_documents/m5stack-core/m5core_gray.md +++ b/docs/product_documents/m5stack-core/m5core_gray.md @@ -44,7 +44,7 @@ Motion" via M5Stack GRAY in a day in stead of couple weeks and so on. ## DOCUMENTS -- [Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH(20171206).pdf) +- [Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf) - Example From e2ac4bd3eccb1d6a537f4213c003856c0769df38 Mon Sep 17 00:00:00 2001 From: Shinichi Ohki Date: Wed, 24 Oct 2018 20:17:42 +0900 Subject: [PATCH 2/3] Fix URL String. --- docs/product_documents/m5stack-core/m5core_basic.md | 2 +- docs/product_documents/m5stack-core/minicore_stick.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/product_documents/m5stack-core/m5core_basic.md b/docs/product_documents/m5stack-core/m5core_basic.md index cb939a87..aef620a9 100644 --- a/docs/product_documents/m5stack-core/m5core_basic.md +++ b/docs/product_documents/m5stack-core/m5core_basic.md @@ -43,7 +43,7 @@ and so on. ## DOCUMENTS -- [Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH(20171206).pdf) +- [Schematic](https://github.com/m5stack/M5-3D_and_PCB/blob/master/M5_Core_SCH%2820171206%29.pdf) - Example diff --git a/docs/product_documents/m5stack-core/minicore_stick.md b/docs/product_documents/m5stack-core/minicore_stick.md index bbc9593b..dc72f2d3 100644 --- a/docs/product_documents/m5stack-core/minicore_stick.md +++ b/docs/product_documents/m5stack-core/minicore_stick.md @@ -1,3 +1,3 @@ # Stick -## (coming soom...) \ No newline at end of file +## (coming soon...) \ No newline at end of file From b43598578bf2400255133145cb28fc4886a9c623 Mon Sep 17 00:00:00 2001 From: watson134 <854410664@qq.com> Date: Wed, 24 Oct 2018 23:36:37 +0800 Subject: [PATCH 3/3] add some chinese articles --- README.md | 2 ++ docs/README_cn.md | 23 +++++++++++++++++++++++ docs/README_jp.md | 3 +++ docs/faq_jp.md | 4 +++- docs/index.html | 6 +++++- docs/index_cn.md | 1 + docs/practice_cn.md | 2 +- docs/quick_start_cn.md | 41 ++++++++++++++++++++--------------------- 8 files changed, 58 insertions(+), 24 deletions(-) create mode 100644 docs/README_cn.md create mode 100644 docs/README_jp.md create mode 100644 docs/index_cn.md diff --git a/README.md b/README.md index d4025ee9..9dd380bd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # M5Stack +[中文](docs/README_cn.md) | English | [日本語](docs/README_jp.md) + **Welcome to M5Stack Documents!** ## Introduction diff --git a/docs/README_cn.md b/docs/README_cn.md new file mode 100644 index 00000000..7b1d75bc --- /dev/null +++ b/docs/README_cn.md @@ -0,0 +1,23 @@ +# M5Stack + +中文 | [English](README.md) | [日本語](docs/README_jp.md) + +**Welcome to M5Stack Documents!** + +## 介绍(Introduction) + +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小.** + +**The M5 stack aims to take the pain out of developing your new inventions and ideas. M5 stack comes packed with sensors, wifi, bluetooth, a screen and its own power supply which avoids the inconvenience of messy wires strewn across breadboards and adding new functionality is as simple as stacking it on top of one of the many expansion modules or plugging in a unit via the handy grove connectors.** + +我们的一系列产品基本以 **ESP32** 芯片为主控芯片. + +我们的产品出发点是 "**堆叠既是产品**". 这是公司官网 [Official Website](http://www.m5stack.com) + + +## 联系我们(Contact & Support) + +- :computer: 访问我们的[官网](http://www.m5stack.com) 了解最新的产品 +- :busts_in_silhouette: 登陆我们的 [论坛](http://forum.m5stack.com) 了解更多创意的设计 +- :mailbox_with_mail: 如果您有任何关于产品的问题，可以随时通过 [邮件](tech@m5stack.com)联系我们，我们坚持24小时在线及时回复您。 +- :convenience_store: 如果您想继续购买我们的产品，欢迎来 [官方旗舰店](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) diff --git a/docs/README_jp.md b/docs/README_jp.md new file mode 100644 index 00000000..446cbb90 --- /dev/null +++ b/docs/README_jp.md @@ -0,0 +1,3 @@ +# よくある質問 + +## (近日公開...) \ No newline at end of file diff --git a/docs/faq_jp.md b/docs/faq_jp.md index 446cbb90..411c6723 100644 --- a/docs/faq_jp.md +++ b/docs/faq_jp.md @@ -1,3 +1,5 @@ -# よくある質問 +# M5Stack + +[中文](docs/README_cn.md) | [English](docs/README.md) | 日本語 ## (近日公開...) \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index c0b155f4..1c2a0dee 100644 --- a/docs/index.html +++ b/docs/index.html @@ -42,8 +42,12 @@ alias: { '.*?/changelog': 'https://unpkg.com/docsify-themeable/CHANGELOG.md', '/cn/practice_cn': 'docs/practice_cn.md', + '/cn/': 'README_cn.md', + '/cn/product_documents_cn': 'docs/product_documents_cn.md', + + }, - auto2top : true, + // auto2top : true, maxLevel : 3, subMaxLevel: 3, diff --git a/docs/index_cn.md b/docs/index_cn.md new file mode 100644 index 00000000..e7a8d3e4 --- /dev/null +++ b/docs/index_cn.md @@ -0,0 +1 @@ +# 中文介绍 \ No newline at end of file diff --git a/docs/practice_cn.md b/docs/practice_cn.md index 625d8ee8..591b20a7 100644 --- a/docs/practice_cn.md +++ b/docs/practice_cn.md @@ -1,4 +1,4 @@ -# 练习 Practice +# 练习(ractice) | | ---|---|--- diff --git a/docs/quick_start_cn.md b/docs/quick_start_cn.md index 53658002..5f7aca2b 100644 --- a/docs/quick_start_cn.md +++ b/docs/quick_start_cn.md @@ -1,32 +1,32 @@ -# 快速上手 Quick Start +# 快速上手(Quick Start) -**This document is intended to help you set up the software environment(Arudino, MicroPython) for development of M5Stack. Through a simple example we would like to illustrate how to develop M5Stack boards, firmware(Arduino) or source files(MicroPython) download to M5Stack boards.** +**这篇文章主要帮助你搭建M5Stack系列产品中Arduino，MicroPython的开发环境，并通过简单的例子引导你学会使用和开发M5Stack的所有产品，实现自己的创意作品。** -## 介绍 Introduction +## 介绍(Introduction) -**M5 stack is a modular stackable development device. The M stands for Modular and 5 stands for the the units compact 5 x 5 cm size.** +**M5是以M5Core主控为核心的一系列可堆叠、模块化的电子产品。 M 代表可堆叠的模块，5 代表模块尺寸为5 * 5 cm大小。** -## 需要准备的 What You Need +## 需要准备的(What Your Need) -To develop applications for M5Stack Core you need: +在开发之前，你需要着手准备一下东西： -* **PC** loaded with either Windows, Linux or Mac operating system -* a **Type-C** cable +* 一台装了Windows, Linux 或者 Mac系统的**电脑** +* 一根 **Type-C** 线 -Before setting development environment, the step below you need to follow: +在搭建环境之前，你需要做一下软件准备： -1. Establish **serial** connection +1. 建立板子和PC之间的串口连接： - [How to Establish serial connection](related_documents\establish_serial_connection) + [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) -## 快速上手 Quick Start +## 快速上手(Quick Start) -!> **Notice** Make sure you have installed USB driver so that your board can establish serial connection with PC. If not, please view this article [How to Establish serial connection](related_documents\establish_serial_connection) for connection. +!> **注意** 确保你的板子已经能够与PC进行串口通信。如果还没的话，参考这篇教程 [如何下载串口驱动并建立串口连接](related_documents\establish_serial_connection) for connection. -At the first time, you need to burn the specific firmware file(.bin) to your board following this article [How to burn firmware](related_documents\how_to_connect_wifi_using_core) befor developing it. +首先，在能进行串口通讯之后，你要根据板子类型和下面的教程，下载对应的固件程序(.bin)到板子里。 固件程序后缀名是.bin。 [如何烧录固件程序](related_documents\how_to_connect_wifi_using_core) -If you have one of ESP32 development boards listed below, click the corresponding one to start your development. +点击下图中你所对应的板子开始开发，实现创意： | | ---|---|--- @@ -36,8 +36,7 @@ If you have one of ESP32 development boards listed below, click the correspondin ## 练习(Practice) -**For being familiar with the programming mode you lik, We suggest you following the corresponding option to do more practices.** - +**最好做一下下面对应的练习版块，这样更加熟悉如何使用M5Stack产品。** | | ---|---|--- @@ -45,7 +44,7 @@ If you have one of ESP32 development boards listed below, click the correspondin ## 相关文档(Related Documents) - - [establish_serial_connection](related_documents/establish_serial_connection) - - [how_to_burn_firmware_en](related_documents/how_to_burn_firmware_en) - - [how_to_connect_wifi_using_core](related_documents/how_to_connect_wifi_using_core) - - [upgrade_m5stack_lib](related_documents/upgrade_m5stack_lib) \ No newline at end of file + - [如何下载串口驱动并建立串口连接](related_documents/establish_serial_connection) + - [如何烧录固件](related_documents/how_to_burn_firmware_en) + - [如何让Core连接能上网的WIFI热点](related_documents/how_to_connect_wifi_using_core) + - [如何升级Arduino IDE中的M5Stack库](related_documents/upgrade_m5stack_lib) \ No newline at end of file