From 6480c73add6546cea2d54c4d765b41a11402d268 Mon Sep 17 00:00:00 2001
From: sangxin <sangxin2014@sina.com>
Date: Mon, 30 Aug 2021 19:55:58 +0800
Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9readme.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md    | 57 ++++++++++++++++++++++++++++++++++++++++++----
 README_EN.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 117 insertions(+), 4 deletions(-)
 create mode 100644 README_EN.md

diff --git a/README.md b/README.md
index 8429c34..7e98d42 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,62 @@
 # ros2bag_convert
 
+[中文](README.md) | [English](README_EN.md)
 
-Convert ROS2 bag files to CSV, JSON, etc. 
+**将ROS2的Bag文件转换为CSV、JSON等。**
 
-将ROS2的Bag文件转换为CSV、JSON等。
+## 一、安装
 
+命令行安装：
 
-### 测试
+```
+sudo pip install ros2bag_convert
+```
+
+下载安装：
+
+```
+git clone git@github.com:fishros/ros2bag_convert.git
+cd ros2_convert
+python3 setup.py bdist_wheel
+sudo pip install dist/ros2bag_convert-0.1.0-py3-none-any.whl
+```
+
+## 二、使用
+
+目前仅支持将数据转换为csv格式，结果将输出到`xxx.db3`同级目录。
+
+```
+ros2bag-convert xxxx.db3
+```
+
+### 测试指令
+
+#### 手动发布Pose数据
 
 ```
 ros2 topic pub test geometry_msgs/msg/Pose  '{position:{x: 0.0,y: 0.0,z: 0.0}, orientation: {x: 0.0,y: 0.0,z: 0.0,w: 1.0}}'
-```
\ No newline at end of file
+```
+
+#### 记录
+
+```
+ros2 bag record test
+```
+
+#### 转换
+
+```
+ros2bag-convert xxxx.db3
+```
+
+## 作者
+
+- [小鱼-公众号鱼香ROS](https://www.fishros.com)
+
+![img](http://tools.fishros.com/README/imgs/image-20210726192026520.png)
+
+## 版本记录
+
+- 20210830-V0.1.0
+  - 完成基础转换功能
+  - 已知bug：数据未按层级展开输出
\ No newline at end of file
diff --git a/README_EN.md b/README_EN.md
new file mode 100644
index 0000000..7101704
--- /dev/null
+++ b/README_EN.md
@@ -0,0 +1,64 @@
+# ros2bag_convert
+
+[Chinese](README.md) | [English](README_EN.md)
+
+** Convert ROS2 Bag files to CSV, JSON, etc. **
+
+## I. Installation
+
+Command line installation.
+
+```
+sudo pip install ros2bag_convert
+```
+
+Download and install.
+
+```
+git clone git@github.com:fishros/ros2bag_convert.git
+cd ros2_convert
+python3 setup.py bdist_wheel
+sudo pip install dist/ros2bag_convert-0.1.0-py3-none-any.whl
+```
+
+## II. Use
+
+Currently only support converting data to csv format, the result will be output to `xxx.db3` sibling directory.
+
+```
+ros2bag-convert xxxx.db3
+```
+
+### Test command
+
+#### Manually publish Pose data
+
+```
+ros2 topic pub test geometry_msgs/msg/Pose '{position:{x: 0.0,y: 0.0,z: 0.0}, orientation: {x: 0.0,y: 0.0,z: 0.0,w: 1.0}}'
+```
+
+#### record
+
+```
+ros2 bag record test
+```
+
+#### convert
+
+```
+ros2bag-convert xxxx.db3
+```
+
+## Author.
+- [小鱼-公众号鱼香ROS](https://www.fishros.com)
+
+![img](http://tools.fishros.com/README/imgs/image-20210726192026520.png)
+
+
+## Version Record
+
+- 20210830-V0.1.0
+  - Completed basic conversion function
+  - Known bug: Data is not exported by hierarchical expansion
+
+Translated with www.DeepL.com/Translator (free version)
\ No newline at end of file