Skip to content

Commit 06cde5b

Browse files
committed
Update.
1 parent 37ce3c4 commit 06cde5b

File tree

8 files changed

+142
-3
lines changed

8 files changed

+142
-3
lines changed

docs/about.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
id: about
3+
title: 关于
4+
sidebar_position: 6
5+
---
6+
7+
# 关于本项目
8+
9+
XRobot前身为[qdu-rm-mcu](https://gitee.com/qsheeeeen/qdu-rm-mcu.git),在2019年1月19日由[@qsheeeeen](https://gitee.com/qsheeeeen)创建。至今一直作为青岛大学Robomaster未来战队的电控框架,同时被多所高校和公司使用。耗时多年,XRobot从一个基于Keil MDK的战车MCU代码,成长为一个跨平台的嵌入式软件框架,再进化为覆盖完整嵌入式开发流程的“神兵利器”。历经风风雨雨,XRobot2.0正式发布,希望与你一同前进。
10+
11+
合作或其他问题请随时联系我们
12+
13+
Github主页: [@xiao](https://github.com/Jiu-xiao)
14+
15+
邮箱:[Cong.Liu_Xiao@outlook.com](Cong.Liu_Xiao@outlook.com)

docs/basic_coding/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: basic-coding
3+
title: 基础编程(libxr)
4+
sidebar_position: 5
5+
---
6+
7+
# 基础编程(libxr)
8+
9+
本页面简要介绍 LibXR 的CMake配置与基础API的使用方法,包括常用工具,外设,操作系统API以及各种控制算法。

docs/code_gen/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
id: code-gen
3-
title: 代码生成
3+
title: 代码生成(CodeGenerator)
44
sidebar_position: 3
55
---
66

7-
# 本页将介绍LibXR的代码生成器(CodeGenerator)的使用方法。
7+
# 代码生成(CodeGenerator
88

99
CodeGenerator本质上是根据SDK的工程文件生成对应的代码,例如依靠STM32CubeMX的IOC文件,生成相应的C++外设初始化代码。本章主要讲解代码生成和配置的方法,不包含具体API的使用。

docs/proj_man/README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: proj-man
3+
title: 项目管理(XRobot)
4+
sidebar_position: 4
5+
---
6+
7+
# 项目管理(XRobot)
8+
9+
本页面简要介绍 XRobot 在嵌入式项目中的基本用法,包括模块拉取、配置和主函数生成等。详细的命令说明将在后续页面中分模块展开。
10+
11+
## 使用前提
12+
13+
确保已通过 pip 或 pipx 安装 `xrobot` 工具:
14+
15+
```bash
16+
pip install xrobot
17+
# 或使用 pipx
18+
pipx install xrobot
19+
```
20+
21+
## 基本目录结构
22+
23+
XRobot 使用约定的目录布局进行模块管理和代码生成:
24+
25+
```bash
26+
YourProject/
27+
├── Modules/ # 存放模块仓库
28+
│ └── modules.yaml # 仓库列表
29+
├── User/ # 用户配置与生成输出
30+
│ ├── xrobot.yaml # 构造参数配置
31+
│ └── xrobot_main.hpp # 自动生成主函数
32+
```
33+
34+
## 工具说明
35+
36+
XRobot 工具集包括以下命令,具体用法见后续子页面:
37+
38+
- `xrobot_add_mod`:添加模块仓库或模块实例
39+
- `xrobot_init_mod`:拉取/更新模块仓库
40+
- `xrobot_gen_main`:生成主函数代码
41+
- `xrobot_create_mod`:创建模块模板
42+
- `xrobot_mod_parser`:解析模块头文件中的构造参数
43+
- `xrobot_setup`:一键生成入口文件和配置
44+
45+
后续页面将逐个介绍这些命令的详细用法与参数。
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
id: about
3+
title: About
4+
sidebar_position: 6
5+
---
6+
7+
# About This Project
8+
9+
XRobot originated from [qdu-rm-mcu](https://gitee.com/qsheeeeen/qdu-rm-mcu.git), created by [@qsheeeeen](https://gitee.com/qsheeeeen) on January 19, 2019. Since then, it has served as the electrical control framework for the Robomaster Future Team at Qingdao University and has also been adopted by various universities and companies.
10+
11+
Over the years, XRobot has evolved from a simple Keil MDK-based MCU codebase for a combat vehicle into a cross-platform embedded software framework—and now, into a powerful toolchain covering the full embedded development lifecycle. After weathering many challenges, XRobot 2.0 is officially released, and we look forward to progressing together with you.
12+
13+
For collaboration or any other inquiries, feel free to contact us:
14+
15+
GitHub: [@xiao](https://github.com/Jiu-xiao)
16+
Email: [Cong.Liu_Xiao@outlook.com](mailto:Cong.Liu_Xiao@outlook.com)
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
id: basic-coding
3+
title: Basic Programming (libxr)
4+
sidebar_position: 5
5+
---
6+
7+
# Basic Programming (libxr)
8+
9+
This page provides a brief introduction to CMake configuration and basic API usage in LibXR, including common utilities, peripherals, OS APIs, and various control algorithms.

i18n/en/docusaurus-plugin-content-docs/current/code_gen/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ title: Code Generation
44
sidebar_position: 3
55
---
66

7-
# This page introduces how to use the `CodeGenerator` in LibXR.
7+
# CodeGenerator
88

99
The `CodeGenerator` essentially generates corresponding source code based on the SDK's project files. For example, it can use an STM32CubeMX IOC file to generate the relevant C++ peripheral initialization code. This chapter mainly discusses the usage of code generation and configuration, and does not include the usage of specific APIs.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
id: proj-man
3+
title: Project Management (XRobot)
4+
sidebar_position: 4
5+
---
6+
7+
# Project Management (XRobot)
8+
9+
This page provides a brief overview of how to use XRobot in embedded projects, including module pulling, configuration, and main function generation. Detailed command descriptions will be provided in subsequent pages, organized by module.
10+
11+
## Prerequisites
12+
13+
Ensure that the `xrobot` tool is installed via pip or pipx:
14+
15+
```bash
16+
pip install xrobot
17+
# Or use pipx
18+
pipx install xrobot
19+
```
20+
21+
## Basic Directory Structure
22+
23+
XRobot uses a conventional directory layout for module management and code generation:
24+
25+
```
26+
YourProject/
27+
├── Modules/ # Stores module repositories
28+
│ └── modules.yaml # Repository list
29+
├── User/ # User configuration and generated output
30+
│ ├── xrobot.yaml # Configuration for constructor parameters
31+
│ └── xrobot_main.hpp # Auto-generated main function
32+
```
33+
34+
## Tool Overview
35+
36+
The XRobot toolset includes the following commands. Detailed usage and parameters will be covered in later subpages:
37+
38+
- `xrobot_add_mod`: Add a module repository or module instance
39+
- `xrobot_init_mod`: Pull or update module repositories
40+
- `xrobot_gen_main`: Generate main function code
41+
- `xrobot_create_mod`: Create a module template
42+
- `xrobot_mod_parser`: Parse constructor parameters from module header files
43+
- `xrobot_setup`: One-click generation of entry files and configuration
44+
45+
These commands will be introduced in detail one by one in the following pages.

0 commit comments

Comments
 (0)