# Document

**Repository Path**: tobudos/Document

## Basic Information

- **Project Name**: Document
- **Description**: TobudOS社区文档中心
- **Primary Language**: HTML
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2024-01-04
- **Last Updated**: 2025-03-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TobudOS文档库

欢迎来到TobudOS文档库！

TobudOS 是面向物联网领域开发的实时操作系统，早期版本基于腾讯自研的物联网操作系统TobudOS，2020年由腾讯捐赠到开放原子开源基金会进行孵化，2023年正式更名为TobudOS，TobudOS具有低功耗，低资源占用，模块化，安全可靠等特点，可有效提升物联网终端产品开发效率，提供精简的 RTOS 内核，内核组件可裁剪可配置，可快速移植到多种主流 MCU (如 STM32 全系列) 及模组芯片上。而且，基于 RTOS 内核提供了丰富的物联网组件，内部集成主流物联网协议栈（如 CoAP/MQTT/TLS/DTLS/LoRaWAN/NB-IoT 等），可助力物联网终端设备及业务快速接入物联网云平台。


## 如何贡献

欢迎贡献TobudOS！

### 贡献TobudOS

### 贡献文档

1. Fork [文档仓库](https://atomgit.com/tobudos/Document)
2. 将您Fork后的文档仓库clone至本地

    ```sh
    git clone git@gitee.com:yourname/tobudos/Document.git # (1)
    ```

    （你需要将`yourname` 更换为你自己的 Gitee 用户名）

3. 安装环境
    - 安装Python 3.x
    - 安装[mkdocs-material](https://squidfunk.github.io/mkdocs-material/)及多语言插件

    ``` sh
    pip install mkdocs-material mkdocs-static-i18n
    ```

    - 在本地运行预览服务器

    ``` sh
    mkdocs serve
    ```

4. 可以开始贡献啦！
    - 具体markdown及本文档站支持的显示特性可查看mkdocs-material的[说明文档](https://squidfunk.github.io/mkdocs-material/reference/)。

5. 向 [文档仓库](https://atomgit.com/tobudos/Document) 提交 Pull Request，待维护者审核通过后，会进行手动合并，或者CI流水线审核通过后自动合并，合并完成稍等片刻后，清除网页缓存后，刷新网页就能看到修改结果，正式网站会每周日同步修改更新。