Skip to content

Commit

Permalink
[doc] 更新文档格式
Browse files Browse the repository at this point in the history
  • Loading branch information
huuhghhgyg committed Apr 30, 2024
1 parent 4182e2f commit a9acd66
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
2 changes: 2 additions & 0 deletions docs/readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# 文档

仿真整体流程和 `watchdog` 组件的的使用参见 [watchdog](./watchdog.md)

智能体(Agent)的基本功能和使用参见 [agent](./agent.md),其基本模板参见 [agent-template](./agent-template.md)

港口中的组件参见 [components/](./components/),其中包括 AGV、堆场、船舶、起重机等。

## 其他相关文件
Expand Down
16 changes: 8 additions & 8 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@

## 开始使用

[AgentTest](./tests/AgentTest.lua)为例介绍如何在 MicroCity 中使用本项目。
[test/AgentTest.lua](./tests/AgentTest.lua)为例介绍如何在 MicroCity 中使用本项目。

1. 首先在 MicroCity 中打开 AgentTest.lua 文件。
2. 接着上传相关的库文件到 MicroCity 的虚拟磁盘中。
- 首先上传[watchdog](./watchdog.lua),用于控制仿真过程。
- 然后根据脚本使用的组件上传其他组件。如[AgentTest](./tests/AgentTest.lua#L6)中第 6 行`require('agent')`,表示引用了[agent](./agent.lua)组件,因此也需要上传到 MicroCity 的虚拟磁盘中。
3. 点击运行,即可开始仿真
3. 点击运行,即可开始运行仿真。可以随时点击命令栏的停止按钮 ⏹ 停止仿真

## 项目结构

| 目录 | 说明 |
| ----------- | ---------------------------------------------------------------------------- |
| `/` | 根目录,存放了所有的组件,包括 agent、watchdog、agv 等 |
| `tests/` | 测试目录,存放了测试脚本,用于测试各个组件的功能,同时也作为使用各组件的示例 |
| `docs/` | 文档目录,存放了各个组件的文档,包括组件的功能、参数、使用方法等 |
| `examples/` | 功能测试目录,存放了一些技术方法的实现的示例脚本 |
| 目录 | 说明 |
| ------------------------ | ---------------------------------------------------------------------------- |
| [/](./) | 根目录,存放了所有的组件,包括 agent、watchdog、agv 等 |
| [tests/](./tests/) | 测试目录,存放了测试脚本,用于测试各个组件的功能,同时也作为使用各组件的示例 |
| [docs/](./docs/) | 文档目录,存放了各个组件的文档,包括组件的功能、参数、使用方法等 |
| [examples/](./examples/) | 功能测试目录,存放了一些技术方法的实现的示例脚本 |

0 comments on commit a9acd66

Please sign in to comment.