Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
developer2324 committed Nov 14, 2018
1 parent a6b35e9 commit 95d9063
Show file tree
Hide file tree
Showing 92 changed files with 8,323 additions and 9 deletions.
3,590 changes: 3,590 additions & 0 deletions doc/Huawei_LiteOS_Developer_Guide_en.md

Large diffs are not rendered by default.

3,043 changes: 3,043 additions & 0 deletions doc/Huawei_LiteOS_Developer_Guide_zh.md

Large diffs are not rendered by default.

1,484 changes: 1,484 additions & 0 deletions doc/Huawei_LiteOS_SDK_Developer_Guide.md

Large diffs are not rendered by default.

127 changes: 118 additions & 9 deletions doc/LiteOS_Code_Info.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,50 @@ int main(void)
<td>agent_tiny</td>
<td>agent_tiny端云互通组件,包括公共头文件、示例代码、客户端实现代码、操作系统适配层代码</td>
</tr>
<tr>
<td></td>
<td></td>
<td>at_frame</td>
<td>LiteOS AT框架实现</td>
</tr>
<tr>
<td></td>
<td></td>
<td>lwm2m</td>
<td>lwm2m协议实现</td>
</tr>
<tr>
<td></td>
<td></td>
<td>nbiot</td>
<td>LiteOS NB-IoT API</td>
</tr>
<tr>
<td></td>
<td></td>
<td>paho.mqtt.embedded-c-1.1.0</td>
<td>MQTT开源协议实现</td>
</tr>
<tr>
<td></td>
<td>fota</td>
<td></td>
<td>固件升级代码</td>
</tr>
</tr>
<tr>
<td></td>
<td>fs</td>
<td></td>
<td>文件系统,含VFS、spiffs、ramfs、kifs、devfs</td>
</tr>
</tr>
<tr>
<td></td>
<td>lib</td>
<td>libc</td>
<td>LiteOS libc优化</td>
</tr>
<tr>
<td></td>
<td>net</td>
Expand Down Expand Up @@ -165,29 +203,100 @@ int main(void)
<td>tickless</td>
<td>低功耗框架代码</td>
</tr>

<tr>
<td>targets</td>
<td>FRDM_KW41Z</td>
<td>Cloud_NB-IoT_STM32F103RE_OneNET</td>
<td></td>
<td>中国移动OneNet NB-IoT 端云demo工程</td>
</tr>
<tr>
<td></td>
<td>Cloud_NXP51U68</td>
<td></td>
<td>NXP ARM Cortex M0 ENC28J60以太网LiteOS SDK端云demo</td>
</tr>
<tr>
<td></td>
<td>Cloud_STM32F429IGTx_FIRE</td>
<td></td>
<td>野火STM32F429(ARM Cortex M4)以太网/ESP8266串口WiFi/SIM900A GPRS/NB-IoT BC95四种连接方式的LiteOS SDK端云demo,内部用编译宏区分,其中wifi、gprs、NB-IOT使用LiteOS SDK的AT框架实现</td>
</tr>
<tr>
<td></td>
<td>Cloud_STM32L431RxTx_IoTClub</td>
<td></td>
<td>物联网俱乐部EVB-M1 STM32L431(ARM Cortex M4)ESP8266WiFi/NB-IoT BC95两种连接方式的LiteOS SDK端云demo</td>
</tr>
<tr>
<td></td>
<td>Cloud_STM3210E_EVAL</td>
<td></td>
<td>STM3210E(ARM Cortex M3)W5500 以太网LiteOS SDK端云demo</td>
</tr>
<tr>
<td></td>
<td>Cloud_wifi_STM32F429ZI_NUCLEO</td>
<td></td>
<td>STM32F429(ARM Cortex M4)marvell SDIO wifi LiteOS SDK端云demo</td>
</tr>
<tr>
<td></td>
<td>Cloud_wifi_STM32F767ZI_NUCLEO</td>
<td></td>
<td>STM32F767(ARM Cortex M7)esp8266 spi wifi LiteOS SDK端云demo</td>
</tr>
<tr>
<td></td>
<td>Demo_Tutorial_STM32F103VC_TAIBI</td>
<td></td>
<td>STM32F103_TAIBI(ARM Cortex M3)LiteOS入门demo,最简单的LED点灯示例程序</td>
</tr>
<tr>
<td></td>
<td>Standard_FRDM_KW41Z</td>
<td></td>
<td>FRDM(ARM Cortex M0+)Standard前缀命名的工程仅为内核移植demo,下同(含原厂芯片驱动)</td>
</tr>
<tr>
<td></td>
<td>Standard_IMXRT1052_FIRE</td>
<td></td>
<td>IMXRT1052(ARM Cortex M7)跨界处理器NXP IMXRT1052内核移植demo(含原厂芯片驱动)</td>
</tr>
<tr>
<td></td>
<td>Standard_msp430f5438a_taurus_v4.2</td>
<td></td>
<td>MSP430(TI 16位低功耗单片机)LiteOS首个16位单片机内核移植demo(含原厂芯片驱动)</td>
</tr>
<tr>
<td></td>
<td>Standard_NRF51822_BLE</td>
<td></td>
<td>NRF51822(ARM Cortex M0)NRF51822蓝牙芯片内核移植demo(含原厂芯片驱动)</td>
</tr>
<tr>
<td></td>
<td>Standard_STM32F0Discovery</td>
<td></td>
<td>FRDM(ARM Cortex M0+)板端工程代码(含原厂芯片驱动)</td>
<td>STM32F0Discovery(ARM Cortex M0)STM32F0 内核移植demo,RAM 8KB,资源裁剪可参考该工程配置(含原厂芯片驱动)</td>
</tr>
<tr>
<td></td>
<td>STM32F103RB_NUCLEO</td>
<td>Standard_STM32F103RB_NUCLEO</td>
<td></td>
<td>F103(ARM Cortex M3)板端工程代码(含原厂芯片驱动)</td>
<td>F103(ARM Cortex M3)STM32F103内核移植demo(含原厂芯片驱动)</td>
</tr>
<tr>
<td></td>
<td>STM32F429IGTx_FIREL</td>
<td>Standard_STM32F103VC_TAIBI</td>
<td></td>
<td>F429(ARM Cortex M4)板端工程代码(含原厂芯片驱动)</td>
<td>STM32F103VC_TAIBI(ARM Cortex M3)钛比STM32F103开发板内核移植demo(含原厂芯片驱动)</td>
</tr>
<tr>
<td></td>
<td>STM32F746ZG_NUCLEO</td>
<td>Standard_STM32F746ZG_NUCLEO</td>
<td></td>
<td>F746(ARM Cortex M7)板端工程代码(含原厂芯片驱动)</td>
<td>F746(ARM Cortex M7)STM32F746内核移植demo(含原厂芯片驱动)</td>
</tr>
</table>
88 changes: 88 additions & 0 deletions doc/LiteOS_Contribute_Guide_GitGUI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
## LiteOS贡献代码流程
进行LiteOS的代码贡献可以遵循以下流程

1. 创建github账号
2. fork LiteOS Kernel源代码
3. 创建开发分支
4. 同步LiteOS主仓库代码到fork的仓库
5. 提交pull request到LiteOS仓库

### 1 创建GitHub账号

由于LiteOS是在GitHub上进行代码管理的,因此代码贡献者也需要在Github上注册账户才能贡献代码。
在浏览器输入github.com,然后在其界面上进行账户的注册(如有github账户,则直接使用即可)。

![](./meta/guides/github_regist.png)

### 2 fork LiteOS源代码

拥有Github账户后,则可以将LiteOS仓库fork到自己账户下,步骤如下:

- 首先登录github账户
- 然后在github中找到https://github.com/LITEOS/LiteOS
![](./meta/guides/github_fork.png)

- 点击fork按钮,将LiteOS的代码fork到自己账户下(比如:我的账户是mychaser)
![](./meta/guides/github_fork2.png)

![](./meta/guides/github_fork3.png)

点击完成后,稍等一会就会自动跳转到自己账户下的LiteOS位置。

![](./meta/guides/github_fork4.png)

### 3 创建开发分支

在自己的账户下的LiteOS仓库下创建新的开发分支,开发新功能或者修正bug等等。

![](./meta/guides/github_fork5.png)

在上图中master的下拉框点击后,可以选择不同的分支,默认是master,建议选择develop。然后在下拉的菜单中输入新的分支的名字,比如smartcar

![](./meta/guides/github_fork6.png)

点击上图中蓝色的内容,则会创建一个叫做smartcar的分支


### 4 同步LiteOS主仓库代码到fork的仓库

- 开发的第一步,是clone代码到本地PC

git clone https://github.com/mychaser/LiteOS.git

clone之后checkout到smartcar分支

git checkout -b smartcar origin/smartcar

然后在该分支进行开发,开发完成之后,进行git add 添加代码到PC本地的仓库,然后git commit提交到PC本地仓库。

- 由于在开发的过程中,LiteOS的主仓库可能已经更新的许多新的内容,所以建议提交代码到自己账户下的仓库时先同步LiteOS的主仓库的内容,步骤示意如下:

git remote add upstream https://github.com/LITEOS/LiteOS

git remote update upstream

git merge upstream/develop

如果存在冲突,请解决冲突,然后在merge
以上步骤完成之后,再进行git push origin smartcar操作,将代码提交到自己账户的github smartcar分支

说明:所有git命令相关内容,如果不熟悉,请自行google或者baidu查找。


### 5 提交pull request到LiteOS仓库

代码开发完毕之后,就可以向LiteOS的主仓库提交pull request,该操作在github网页上进行操作。

点击 New pull request

![](./meta/guides/github_fork7.png)

![](./meta/guides/github_fork8.png)
在上图中 1 标识的位置选择 develop , 2 标识的位置选择smartcart

如果没有冲突则会显示 3所示内容,否则需要先解决冲突然后重新创建pull request。

选择完成后,并输入相关描述,最后点击绿色按钮 Create pull request 完成pull request的创建。

注:请将以上示例图中的LiteOS_Kernel替换为LiteOS即可。
Binary file added doc/meta/DevGuide_en/pic1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic10.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic11.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic12.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic13.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic14.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic15.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic16.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic17.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic18.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic19.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic20.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic21.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic22.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic23.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic24.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic25.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic26.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic27.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic28.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic29.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic3.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic30.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic31.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/meta/DevGuide_en/pic4.jpg
Binary file added doc/meta/DevGuide_en/pic5.jpg
Binary file added doc/meta/DevGuide_en/pic6.jpg
Binary file added doc/meta/DevGuide_en/pic7.jpg
Binary file added doc/meta/DevGuide_en/pic8.jpg
Binary file added doc/meta/DevGuide_en/pic9.jpg
Binary file added doc/meta/SDKGuide_AgentTiny/1.png
Binary file added doc/meta/SDKGuide_AgentTiny/10.png
Binary file added doc/meta/SDKGuide_AgentTiny/11.png
Binary file added doc/meta/SDKGuide_AgentTiny/12.png
Binary file added doc/meta/SDKGuide_AgentTiny/13.png
Binary file added doc/meta/SDKGuide_AgentTiny/14.png
Binary file added doc/meta/SDKGuide_AgentTiny/15.png
Binary file added doc/meta/SDKGuide_AgentTiny/16.png
Binary file added doc/meta/SDKGuide_AgentTiny/17.png
Binary file added doc/meta/SDKGuide_AgentTiny/18.png
Binary file added doc/meta/SDKGuide_AgentTiny/19.png
Binary file added doc/meta/SDKGuide_AgentTiny/2.png
Binary file added doc/meta/SDKGuide_AgentTiny/20.png
Binary file added doc/meta/SDKGuide_AgentTiny/21.png
Binary file added doc/meta/SDKGuide_AgentTiny/22.png
Binary file added doc/meta/SDKGuide_AgentTiny/23.png
Binary file added doc/meta/SDKGuide_AgentTiny/24.png
Binary file added doc/meta/SDKGuide_AgentTiny/25.png
Binary file added doc/meta/SDKGuide_AgentTiny/26.png
Binary file added doc/meta/SDKGuide_AgentTiny/27.png
Binary file added doc/meta/SDKGuide_AgentTiny/28.png
Binary file added doc/meta/SDKGuide_AgentTiny/29.png
Binary file added doc/meta/SDKGuide_AgentTiny/3.png
Binary file added doc/meta/SDKGuide_AgentTiny/30.png
Binary file added doc/meta/SDKGuide_AgentTiny/31.png
Binary file added doc/meta/SDKGuide_AgentTiny/32.png
Binary file added doc/meta/SDKGuide_AgentTiny/33.png
Binary file added doc/meta/SDKGuide_AgentTiny/34.png
Binary file added doc/meta/SDKGuide_AgentTiny/35.png
Binary file added doc/meta/SDKGuide_AgentTiny/36.png
Binary file added doc/meta/SDKGuide_AgentTiny/37.jpg
Binary file added doc/meta/SDKGuide_AgentTiny/38.png
Binary file added doc/meta/SDKGuide_AgentTiny/39.jpg
Binary file added doc/meta/SDKGuide_AgentTiny/4.png
Binary file added doc/meta/SDKGuide_AgentTiny/40.png
Binary file added doc/meta/SDKGuide_AgentTiny/41.png
Binary file added doc/meta/SDKGuide_AgentTiny/42.png
Binary file added doc/meta/SDKGuide_AgentTiny/43.png
Binary file added doc/meta/SDKGuide_AgentTiny/44.png
Binary file added doc/meta/SDKGuide_AgentTiny/45.png
Binary file added doc/meta/SDKGuide_AgentTiny/46.png
Binary file added doc/meta/SDKGuide_AgentTiny/47.png
Binary file added doc/meta/SDKGuide_AgentTiny/48.jpg
Binary file added doc/meta/SDKGuide_AgentTiny/49.png
Binary file added doc/meta/SDKGuide_AgentTiny/5.png
Binary file added doc/meta/SDKGuide_AgentTiny/50.jpg
Binary file added doc/meta/SDKGuide_AgentTiny/51.jpg
Binary file added doc/meta/SDKGuide_AgentTiny/52.png
Binary file added doc/meta/SDKGuide_AgentTiny/53.png
Binary file added doc/meta/SDKGuide_AgentTiny/54.png
Binary file added doc/meta/SDKGuide_AgentTiny/55.png
Binary file added doc/meta/SDKGuide_AgentTiny/56.png
Binary file added doc/meta/SDKGuide_AgentTiny/6.gif
Binary file added doc/meta/SDKGuide_AgentTiny/7.jpg
Binary file added doc/meta/SDKGuide_AgentTiny/8.png
Binary file added doc/meta/SDKGuide_AgentTiny/9.png

0 comments on commit 95d9063

Please sign in to comment.