Skip to content

Commit

Permalink
docs: yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
fan-ziqi committed Apr 5, 2024
1 parent a0f7b07 commit 2f7c3ef
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ git pull
git submodule update --remote --recursive
```

## Dependency

Download and deploy `libtorch` at any location

```bash
Expand All @@ -34,6 +36,16 @@ Install `teleop-twist-keyboard`
sudo apt install ros-noetic-teleop-twist-keyboard
```

Install yaml-cpp

```bash
git clone https://github.com/jbeder/yaml-cpp.git
cd yaml-cpp && mkdir build && cd build
cmake -DYAML_BUILD_SHARED_LIBS=on .. && make
sudo make install
sudo ldconfig
```

## Compilation

Customize the following two functions in your code to adapt to different models:
Expand All @@ -52,7 +64,7 @@ catkin build

## Running

Before running, copy the trained pt model file to `rl_sar/src/rl_sar/models`
Before running, copy the trained pt model file to `rl_sar/src/rl_sar/models/YOUR_ROBOT_NAME`, and configure the parameters in `config.yaml`.

### Simulation

Expand Down
8 changes: 3 additions & 5 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ git pull
git submodule update --remote --recursive
```

## 依赖

在任意位置下载并部署`libtorch`

```bash
Expand All @@ -34,8 +36,6 @@ echo 'export Torch_DIR=/path/to/your/torchlib' >> ~/.bashrc
sudo apt install ros-noetic-teleop-twist-keyboard
```

## 依赖

安装yaml-cpp

```bash
Expand All @@ -46,8 +46,6 @@ sudo make install
sudo ldconfig
```

头文件在/usr/local/include,库文件在/usr/local/lib

## 编译

自定义代码中的以下两个函数,以适配不同的模型:
Expand All @@ -66,7 +64,7 @@ catkin build

## 运行

运行前请将训练好的pt模型文件拷贝到`rl_sar/src/rl_sar/models`
运行前请将训练好的pt模型文件拷贝到`rl_sar/src/rl_sar/models/YOUR_ROBOT_NAME`中,并配置`config.yaml`中的参数。

### 仿真

Expand Down

0 comments on commit 2f7c3ef

Please sign in to comment.