up index

BPI-STEAM · Aug 20, 2019 · 54b2462 · 54b2462
1 parent 97c0462
commit 54b2462
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 111 deletions.
diff --git a/source/contents.rst b/source/contents.rst
@@ -1,60 +1,56 @@
-.. Introduction to BPI-STEAM documentation master file, created by
-    sphinx-quickstart on Sun May 26 22:43:43 2019.
-    You can adapt this file completely to your liking, but it should at least
-    contain the root `toctree` directive.
 
 BPI-STEAM 用户文档
-=====================================================
+===================
+
+BPI-STEAM 是专注于软硬件开源技术的开源组织，属于 `Banana-Pi <http://www.banana-pi.org/>`_ 的分支，从 2018 年起推出 BPI-BIT 开发板，随之推出 Webduino 、 MicroPython 、 Arduino 等开源技术支持，通过用户文档能够让用户轻松入门 BPI-STEAM 所提供的技术产品。
 
 .. Hint::
 
-    本文档托管于 `BPI-STEAM <https://github.com/BPI-STEAM>`_ 组织。
+    本文档托管于 `BPI-STEAM <https://github.com/BPI-STEAM>`_ 开源组织。
 
-认识 BPI-BIT 板子
----------------------------
+认识 BPI-BIT 开发板
+-------------------
 
-BPI-BIT 是一款基于 ESP32 高性能芯片且兼容 micro:bit 设计的开源 STEAM 教育开发板。
+BPI-BIT 是一款基于 ESP32 高性能芯片且兼容 micro:bit 设计的开源 STEAM 教育开发板，又名 Bpi:Bit、Web:Bit 。
 
-.. image:: bpi-steam/readme/product.jpg
-    :alt: 正面外观
+.. image:: _static/bit.png
 
 .. toctree::
     :maxdepth: 2
-    :caption: BPI-BIT
 
-    bpi-steam/readme
+    bpi-steam/hardware
     bpi-steam/driver
 
 使用 Webduino 编程
----------------------------
+------------------
+
+通过 Web:Bit 专用积木编辑器，使用拖拽积木来轻松学习编程吧。
 
-用户通过烧写 Webduino 固件，就可以使用面向全世界的 Webduino Blockly 积木化在线编程。
+.. image:: _static/editor.png
 
 .. toctree::
     :maxdepth: 2
-    :caption: Webduino
+    :caption: Webduino 目录
 
-    bpi-web/tutorials/index
-    bpi-web/advanced/index
-    bpi-web/modules/index
-
-只需浏览器，即可随时查看云端和托管你的代码，配合 Github 上各种有趣的插件系统与多语言化环境，享受全世界流行的积木编程吧!
+    webduino/tutorials/index
+    webduino/advanced/index
+    webduino/modules/index
 
 使用 MicroPython 编程
 ---------------------------
 
-用户通过烧写 MicroPython 固件，就可以使用当下世界上最流行的 Python 语言进行编程。
+通过烧写 MicroPython 固件，就可以在开发板中使用 Python 语言进行编程。
 
-提供丰富的 examples 配合专业 IDE 的支持（如：VsCode、PyCharm），以便您轻松地将代码从电脑传输到板子中，从而体验程序创作的无穷乐趣！
+在下述目录将提供丰富的示例代码以及专业 IDE 的支持（如：VsCode、PyCharm）。
 
 .. toctree::
     :maxdepth: 2
-    :caption: MicroPython
+    :caption: MicroPython 目录
 
-    bpi-mpy/tutorials/index
-    bpi-mpy/advanced/index
-    bpi-mpy/samples/index
-    bpi-mpy/modules/index
+    micropython/tutorials/index
+    micropython/advanced/index
+    micropython/samples/index
+    micropython/modules/index
     mPython/docs/library/micropython/index.rst
     mPython/docs/library/pythonStd/index.rst
 
@@ -63,26 +59,26 @@ BPI-BIT 是一款基于 ESP32 高性能芯片且兼容 micro:bit 设计的开源
 
 .. Hint::
 
-    Arduino 将不会阐述过多基础内容，请自行具备 C/C++ 的语言开发基础。
+    Arduino 将不会阐述过多基础内容，请具备 C/C++ 的语言开发基础。
 
-BPI-BIT 提供了入门 Arduino 的软件工具和最佳示例，这将成为你进入嵌入式专业开发的最低门槛。
+提供了入门 Arduino 的软件工具和最佳示例，降低进入 ESP32 嵌入式专业开发的门槛。
 
 .. toctree::
     :maxdepth: 2
-    :caption: Arduino
+    :caption: Arduino 目录
 
-    bpi-adu/tutorials/index
-    bpi-adu/advanced/index
-    bpi-adu/modules/index
+    arduino/tutorials/index
+    arduino/advanced/index
+    arduino/modules/index
 
-拓展板支持
----------------------------
+.. BPI-BIT 拓展板
+.. ---------------------------
 
-BPI-BIT 大幅度的兼容 microbit 的底座硬件设计与使用，你可以查看以下支持的 Microbit 的拓展板或根据拓展板设计方案进行拓展应用。
+.. BPI-BIT 大幅度的兼容 microbit 的底座硬件设计与使用，你可以查看以下支持的 Microbit 的拓展板，或根据我们提供的拓展板设计方案进行拓展应用。
 
-.. toctree::
-    :maxdepth: 2
-    :caption: 拓展板
+.. .. toctree::
+..     :maxdepth: 2
+..     :caption: Bit 拓展板
 
 .. 
 .. toctree::

diff --git a/source/index.rst b/source/index.rst
@@ -1,98 +1,43 @@
-.. Introduction to BPI-STEAM documentation master file, created by
-    sphinx-quickstart on Sun May 26 22:43:43 2019.
-    You can adapt this file completely to your liking, but it should at least
-    contain the root `toctree` directive.
 
 BPI-STEAM 用户文档
-=====================================================
-
-.. Hint::
-
-    本文档托管于 `BPI-STEAM <https://github.com/BPI-STEAM>`_ 组织。
-
-认识 BPI-BIT 板子
----------------------------
-
-BPI-BIT 是一款基于 ESP32 高性能芯片且兼容 micro:bit 设计的开源 STEAM 教育开发板。
-
-.. image:: bpi-steam/readme/product.jpg
-    :alt: 正面外观
+===================
 
 .. toctree::
     :maxdepth: 2
-    :caption: BPI-BIT
 
-    bpi-steam/readme
+    bpi-steam/hardware
     bpi-steam/driver
 
-使用 Webduino 编程
----------------------------
-
-用户通过烧写 Webduino 固件，就可以使用面向全世界的 Webduino Blockly 积木化在线编程。
-
 .. toctree::
     :maxdepth: 2
-    :caption: Webduino
-
-    bpi-web/tutorials/index
-    bpi-web/advanced/index
-    bpi-web/modules/index
-
-只需浏览器，即可随时查看云端和托管你的代码，配合 Github 上各种有趣的插件系统与多语言化环境，享受全世界流行的积木编程吧!
-
-使用 MicroPython 编程
----------------------------
-
-用户通过烧写 MicroPython 固件，就可以使用当下世界上最流行的 Python 语言进行编程。
+    :caption: Webduino 目录
 
-提供丰富的 examples 配合专业 IDE 的支持（如：VsCode、PyCharm），以便您轻松地将代码从电脑传输到板子中，从而体验程序创作的无穷乐趣！
+    webduino/tutorials/index
+    webduino/advanced/index
+    webduino/modules/index
 
 .. toctree::
     :maxdepth: 2
-    :caption: MicroPython
+    :caption: MicroPython 目录
 
-    bpi-mpy/tutorials/index
-    bpi-mpy/advanced/index
-    bpi-mpy/samples/index
-    bpi-mpy/modules/index
+    micropython/tutorials/index
+    micropython/advanced/index
+    micropython/samples/index
+    micropython/modules/index
     mPython/docs/library/micropython/index.rst
     mPython/docs/library/pythonStd/index.rst
 
-使用 Arduino 编程
----------------------------
-
-.. Hint::
-
-    Arduino 将不会阐述过多基础内容，请自行具备 C/C++ 的语言开发基础。
-
-BPI-BIT 提供了入门 Arduino 的软件工具和最佳示例，这将成为你进入嵌入式专业开发的最低门槛。
-
 .. toctree::
     :maxdepth: 2
-    :caption: Arduino
-
-    bpi-adu/tutorials/index
-    bpi-adu/advanced/index
-    bpi-adu/modules/index
+    :caption: Arduino 目录
 
-拓展板支持
----------------------------
-
-BPI-BIT 大幅度的兼容 microbit 的底座硬件设计与使用，你可以查看以下支持的 Microbit 的拓展板或根据拓展板设计方案进行拓展应用。
+    arduino/tutorials/index
+    arduino/advanced/index
+    arduino/modules/index
 
 .. toctree::
     :maxdepth: 2
-    :caption: 拓展板
-
-.. 
-.. toctree::
-    :maxdepth: 2
-    :caption: 引用区域
-    mPython/docs/index
-    micropython/docs/index
-.. 
-
-.. image:: _static/footer.png
+    :caption: Bit 拓展板
 
 Indices and tables
 ==================