Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
update total readme
  • Loading branch information
LitoNeo authored Jul 5, 2021
1 parent 77423e6 commit 189a852
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,26 @@
* @LastEditTime : 2020-01-13 14:10:25
-->
# SmartCar-Tools
Tools for self-driving car
Light-weight tools for self-driving car

## 写在前面
1. 每个单独的模块都有自己的使用说明,参考模块自身的`README.md`
2. 关于环境配置问题,我正在制作Docker镜像
## Description
For the needed of our project, I designed two small tools currently:
1. [grid_map_generator](https://github.com/LitoNeo/SmartCar-pcd-map-Tools/tree/master/map_tools/modules/grid_map_generator): Used to downsample the pcd maps and divide one big pcd map to small one, which are the input of `pcd_map_manager`.
2. [trajectory_generator](https://github.com/LitoNeo/SmartCar-pcd-map-Tools/tree/master/map_tools/modules/trajectory_generator): Used to extract defined driving paths (trajectoies), which is a light-weight description of roads.

**For the useage of each tool, refer to their own `README` document**

## How to Build
This repo depends on QT-5.9 and ROS1.0, be sure it is correctly installed on your pc.
I tested it on `Ubuntu1604`.
I tested it on `Ubuntu1604` and 'Ubuntu1804'

1. `mkdir -p catkin_ws/src && cd catkin_ws/src`
2. `git clone https://github.com/LitoNeo/SmartCar-Tools.git`
3. `cd .. && catkin_make`

## map_tools
> Note: Just as general ROS modules, you need to `source devel/setup.bash` before running the tools
## map_tool modules
> Tools used to process map data.(especially for pcd files)
1. **trajectory_generator**
A qt-based tools used to define and extract drivable trajectory.
Expand All @@ -31,6 +36,3 @@ Currently it only extracts drivable trajectories, that is, a minimum subset of h
A qt-based tools to downsample and mesh the big pcd maps to small one.
For more details, refer [here](https://zhuanlan.zhihu.com/p/77745476)


## driver
> useful driver for self-driving car

0 comments on commit 189a852

Please sign in to comment.