Add Basic

BPI-STEAM · May 28, 2019 · 2b487e4 · 2b487e4
1 parent 8cabbf3
commit 2b487e4
Show file tree

Hide file tree

Showing 15 changed files with 83 additions and 4 deletions.
diff --git a/source/bpi-dev/mpy-release.rst b/source/bpi-dev/mpy-release.rst
@@ -2,8 +2,6 @@
 发布中心
 =====================================================
 
-MicroPython是 Python 3 语言的精简实现 ，包括Python标准库的一小部分，经过优化可在微控制器和受限环境中运行。
-
 这里是 BPI-STEAM 体系的 MicroPyhton 固件、软件的 release 版本发布中心。
 
 release firmware

diff --git a/source/bpi-dev/mpy-tutorials.rst b/source/bpi-dev/mpy-tutorials.rst
@@ -1,3 +1,10 @@
 基础教程
 ========================================
 
+MicroPython是 Python 3 语言的精简实现 ，包括Python标准库的一小部分，经过优化可在微控制器和受限环境中运行。
+
+.. toctree::
+   :maxdepth: 2
+
+   ../bpi-mpy/know_github
+   ../bpi-mpy/flash_mpy
diff --git a/source/bpi-mpy/flash_mpy.rst b/source/bpi-mpy/flash_mpy.rst
@@ -0,0 +1,37 @@
+刷入 MicroPython 固件
+=====================================================
+
+第一次使用，请先烧入 MicroPython 固件，如果不烧录就没有 MicroPython 编程环境。
+
+.. Hint::
+
+    使用请确认已经安装驱动，且已经得知自己的硬件串口名称，例如：COM5、ttyUSB0。
+
+.. toctree::
+   :maxdepth: 2
+
+   ../bpi-steam/driver
+
+在 Windows 下
+---------------------------
+
+- 从 `BPI-BIT-MicroPython/release <https://github.com/BPI-STEAM/BPI-BIT-MicroPython/releases/tag/FlashTool>`_ 中获取烧写工具， 国内可以用 `腾讯微云 <https://share.weiyun.com/5qGEjMu>`_ 下载获得。
+
+- 下载后打开 `FlashMicroPython-*.zip` 压缩包，然后运行里面的 Flashtool.exe 工具即可。
+
+.. image:: https://user-images.githubusercontent.com/32978053/55951621-4a1a7180-5c8a-11e9-8ab8-302d3f482725.png
+
+- 请先插入硬件后打开软件，这个软件会自动运行烧写。
+
+- 你也可以自己选择串口烧录，升级固件只需要替换压缩包中的 firmware.bin 重新烧入即可。
+
+在 其他系统 下
+---------------------------
+
+请参照其他网络教程，如果有特别的需求，可以到 社区 提交问题 或 开 issue 。
+
+.. Attention::
+
+    有问题可以到 `中文社区 <https://forum.banana-pi.org.cn/c/bpi>`_ 反馈。
+
+.. image:: ../../images/logo.png
diff --git a/source/bpi-mpy/know_github.md b/source/bpi-mpy/know_github.md
@@ -0,0 +1,37 @@
+
+# 认识 Github 项目
+
+在这里以 [BPI-BIT-MicroPython](https://github.com/BPI-STEAM/BPI-BIT-MicroPython) 为例。
+
+提示：图片内容已经过时，仅是教会你如何使用 Github ，以便于你之后寻找需要的代码和知识。
+
+## 1. 认识项目
+
+- Github 是一个公共免费的版本管理仓库，大部分也都是开源项目，你可以在这里获得许多你需要的资料或代码等等，而我们的代码等等开源的东西都是存放在 github 的 git 仓库里。
+
+- ![](know_github/base.png)
+
+- 圈起的按钮选项，它对用户而言可以提供以下功能（虽然文档内容可能会与时俱进的更新，但图片所示的大体内容不会改变）。
+
+1. **Code** 指项目存放的开源代码，在这里指的是可以给板子直接使用的示例代码。
+    - ![code](know_github/code.png)
+2. **Issues** 若存在任何疑问都可以在这里发布消息，无论是错误报告还是需要帮助等等。
+    - ![issues](know_github/issues.png)
+3. **Project** 指现在项目的开发情况，在这里可以看到整个项目的开发情况。
+    - ![Project](know_github/project.png)
+4. **Wiki** 查看项目的使用文档，也就是你现在所在的位置。
+    - ![wiki](know_github/wiki.png)
+5. **commits** 指现在项目的更新或提交情况，在这里就可以知道项目的实际进展情况。
+    - ![commits](know_github/commits.png)
+6. **release** 这里就是存放给用户可以直接使用的工具套件以及源代码等。
+    - ![release](know_github/release.png)
+
+## 2. 下载项目
+
+- 如下图可以看到 Clone or Download 按钮，它是将当前项目的示例代码直接打包下载（不包含开发套件）。
+- ![](know_github/into.png)
+- 而获取开发套件需要点 release 或点此进入 [BPI-BIT-MicroPython/releases](https://github.com/BPI-STEAM/BPI-BIT-MicroPython/releases)
+- ![](know_github/list.png)
+- 点击 蓝色字体 即可下载文件，在这个项目里，开发套件工具都是按需下载的，所以需要什么工具的时候，文档开头会提及所需材料。
+
+![](../../images/logo.png)
diff --git a/source/bpi-mpy/know_github/base.png b/source/bpi-mpy/know_github/base.png
diff --git a/source/bpi-mpy/know_github/code.png b/source/bpi-mpy/know_github/code.png
diff --git a/source/bpi-mpy/know_github/commits.png b/source/bpi-mpy/know_github/commits.png
diff --git a/source/bpi-mpy/know_github/into.png b/source/bpi-mpy/know_github/into.png
diff --git a/source/bpi-mpy/know_github/issues.png b/source/bpi-mpy/know_github/issues.png
diff --git a/source/bpi-mpy/know_github/list.png b/source/bpi-mpy/know_github/list.png
diff --git a/source/bpi-mpy/know_github/project.png b/source/bpi-mpy/know_github/project.png
diff --git a/source/bpi-mpy/know_github/release.png b/source/bpi-mpy/know_github/release.png
diff --git a/source/bpi-mpy/know_github/wiki.png b/source/bpi-mpy/know_github/wiki.png
diff --git a/source/contents.rst b/source/contents.rst
@@ -18,7 +18,7 @@ Welcome to BPI-STEAM documentation!
 
 .. image:: ../images/facade.gif
 
-BPI-BIT 是一款基于 ESP32 高性能芯片，且兼容 micro:bit 设计的开源 STEAM 教育产品。
+BPI-BIT 是一款基于 ESP32 高性能芯片且兼容 micro:bit 设计的开源 STEAM 教育产品。
 
 .. toctree::
    :maxdepth: 2

diff --git a/source/index.rst b/source/index.rst
@@ -18,7 +18,7 @@ Welcome to BPI-STEAM documentation!
 
 .. image:: ../images/facade.gif
 
-BPI-BIT 是一款基于 ESP32 高性能芯片，且兼容 micro:bit 设计的开源 STEAM 教育产品。
+BPI-BIT 是一款基于 ESP32 高性能芯片且兼容 micro:bit 设计的开源 STEAM 教育产品。
 
 .. toctree::
    :maxdepth: 2