diff --git a/docs/README.md b/docs/README.md index 21cf5203..d4025ee9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,12 +10,12 @@ Our a series of core boards are based on **ESP32** chip. -Our aim is "**Stackable Board is Product**". Here's the [Official Website](www.m5stack.com) +Our aim is "**Stackable Board is Product**". Here's the [Official Website](http://www.m5stack.com) ## Contact & Support -- :computer: Visit [Official Website](www.m5stack.com) for newest product +- :computer: Visit [Official Website](http://www.m5stack.com) for newest product - :busts_in_silhouette: Sign in our [Forum](http://forum.m5stack.com) for more designs with M5Stack - :mailbox_with_mail: If you have any questions, you can contact us by [Email](tech@m5stack.com) - :convenience_store: If you want to get our products, access our [store](http://www.aliexpress.com/store/all-wholesale-products/3226069.html?spm=2114.12010108.100004.3.7e3a5379KoyhDo) diff --git a/docs/_sidebar.md b/docs/_sidebar.md deleted file mode 100644 index e00744e8..00000000 --- a/docs/_sidebar.md +++ /dev/null @@ -1,21 +0,0 @@ -- Getting started - - [Overview](README.md) - - [Quick Start](quick_start.md) - - [Examples](examples.md) - - [Package structure](package_structure.md) - - [Extending](extending.md) - -- Reference - - [API](api.md) - - [Transforms](transforms.md) - - [Transform groups](transform_groups.md) - - [Formats](formats.md) - - [Templates](templates.md) - - [Actions](actions.md) - - [Build process](build_process.md) - -- **Links** -- [![Code](https://icongr.am/feather/code.svg?size=16&color=808080)Demo Sandbox](https://codesandbox.io/s/xv36w4695o) -- [![Github](https://github.com/watson8544/M5Stack-Documentation-docsify)Github](https://github.com/watson8544/M5Stack-Documentation-docsify) -- [![NPM](https://icongram.jgog.in/simple/npm.svg?colored&size=16)NPM](https://www.npmjs.com/package/docsify-themeable) -- [![Twitter](https://icongram.jgog.in/simple/twitter.svg?colored&size=16)@jhildenbiddle](http://twitter.com/jhildenbiddle) \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 4d29278b..c0b155f4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,21 +1,73 @@ - + + - - docsify-themeable - A delightfully simple theme system for docsify.js. Features multiple themes with rich customization options, an improved desktop and mobile experience, and legacy browser support (IE10+). - - - - + + + + + + M5Stack - A delightfully simple theme system for docsify.js + + + + + + + + + -
- - +
+ + + + + + + + + + + + + + diff --git a/docs/practice_cn.md b/docs/practice_cn.md new file mode 100644 index 00000000..625d8ee8 --- /dev/null +++ b/docs/practice_cn.md @@ -0,0 +1,5 @@ +# 练习 Practice + + | | +---|---|--- +[M5StackCore](establish_serial_connection) | [M5Camera](establish_serial_connection) | [M5BALA](establish_serial_connection) \ No newline at end of file diff --git a/docs/product_documents_cn.md b/docs/product_documents_cn.md new file mode 100644 index 00000000..4c90b01b --- /dev/null +++ b/docs/product_documents_cn.md @@ -0,0 +1,66 @@ +# 产品列表 + + + +| M5Core | MiniCore | +| :----------: |:------------: | +| [BASIC](product_documents/m5stack-core/m5core_basic) | [Stick](minicore_stick) | +| [GRAY](product_documents/m5stack-core/m5core_gray) | / | +| [FIRE](product_documents/m5stack-core/m5core_fire) | / | + + + + + +| 无线通信模块 | 配件模块 | 控制模块 | +| :------------------: |:------------------:| :--------------------:| +| [GPS](product_documents/modules/module_gps) | [PROTO](product_documents/modules/module_proto) | [STEPMOTOR](product_documents/modules/module_stepmotor)| +| [LORA](product_documents/modules/module_lora) | [BATTERY](product_documents/modules/module_battery) | [PLC](product_documents/modules/module_plc) | +| [LAN](product_documents/modules/module_lan) | [BTC](product_documents/modules/module_btc) | [FACES](product_documents/modules/module_face) | +| [SIM800/GPRS/GSM](product_documents/modules/module_sim800) | [PLUS](product_documents/modules/module_plus) | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | +| / | / | / | + + + + +- [LEGO-CABLE](product_documents/cables/accessory_lego_cable) +- [FRAME](product_documents/accessory_frame) + + + + + +| 输入/传感类Unit | 输出/控制类Unit | 接口类Unit | +| :-------------------: |:------------------------: | :----------------:| +| [ENV](product_documents/units/unit_env) | [RGB](product_documents/units/unit_rgb) | [HUB](product_documents/units/unit_hub) | +| [IR](product_documents/units/unit_ir) | [RELAY](product_documents/units/unit_relay) | [3.96PORT](product_documents/units/unit_396port) | +| [PIR](product_documents/units/unit_pir) | [NeoPixel](product_documents/units/unit_neopixel) | / | +| [ANGLE](product_documents/units/unit_angle) | / | / | +| [EARTH/Moisture](product_documents/units/unit_moisture) | / | / | +| [LIGHT](product_documents/units/unit_light) | / | / | +| [MAKEY](product_documents/units/unit_makey) | / | / | +| [BUTTON](product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](product_documents/units/unit_joystick) | / | / | +| [THERMAL](product_documents/units/unit_thermal) | / | / | +| [ADC](product_documents/units/unit_ADC) | / | / | +| [DAC](product_documents/units/unit_DAC) | / | / | +| [Color Sensor](product_documents/units/unit_color_sensor) | / | / | +| [ToF](product_documents/units/unit_tof) | / | / | + + + + + + + +- [BALA](product_documents/applications/application_bala) + + + + +- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) diff --git a/docs/quick_start_cn.md b/docs/quick_start_cn.md new file mode 100644 index 00000000..53658002 --- /dev/null +++ b/docs/quick_start_cn.md @@ -0,0 +1,51 @@ +# 快速上手 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.** + +## 介绍 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.** + + +## 需要准备的 What You Need + +To develop applications for M5Stack Core you need: + +* **PC** loaded with either Windows, Linux or Mac operating system +* a **Type-C** cable + +Before setting development environment, the step below you need to follow: + +1. Establish **serial** connection + + [How to Establish serial connection](related_documents\establish_serial_connection) + +## 快速上手 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. + +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. + +If you have one of ESP32 development boards listed below, click the corresponding one to start your development. + + | | +---|---|--- +[M5StackCore](quick_start/m5core/m5stack_core_quick_start) | [M5Camera](quick_start/m5camera/m5camera_quick_start) | [M5BALA](quick_start/bala/bala_quick_start) + + + +## 练习(Practice) + +**For being familiar with the programming mode you lik, We suggest you following the corresponding option to do more practices.** + + + | | +---|---|--- +[Arduino](practice\practice_arduino) | [M5Flow-Blockly](practice\practice_blockly) | [M5Flow-MicroPython](practice\practice_micropython) + +## 相关文档(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