Skip to content

Commit abf09c5

Browse files
committed
(minor) Fix wrong links and instructions in README.md files
1 parent 85edec2 commit abf09c5

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

README.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,19 @@
3333

3434
* C++ source code of Patchwork++ ([patchworkpp][sourcecodelink])
3535
* Python binding of Patchwork++ using pybind11 ([python_wrapper][wraplink])
36-
* Examples codes, which visualizes a ground segmentation result by Patchwork++ ([examples][examplelink]) :thumbsup:
36+
* Examples codes of [C++][cppexamplelink], [Python][pyexamplelink], and [ROS2][rosexamplelink] :thumbsup:
3737

3838
> If you are familiar with ROS1, you can also visit [here][roslink] and try executing ROS1-based Patchwork++!
3939
4040
[roslink]: https://github.com/url-kaist/patchwork-plusplus-ros
4141

42-
[sourcecodelink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/patchworkpp
42+
[sourcecodelink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/cpp/patchworkpp
4343
[pybind11link]: https://github.com/pybind/pybind11
44-
[wraplink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/python_wrapper
45-
[examplelink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/examples
44+
[wraplink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/python/patchworkpp
45+
46+
[cppexamplelink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/cpp
47+
[pyexamplelink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/python
48+
[rosexamplelink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/ros
4649

4750
## :package: Prerequisite packages
4851
> What we need are just minimal dependencies.
@@ -73,7 +76,7 @@ Only Open3D (> 0.17.0) is additionally installed for visualization purposes.
7376
make pyinstall_with_demo
7477
```
7578

76-
How to run Python demos is explained [here](https://github.com/url-kaist/patchwork-plusplus/tree/master/python/README.md#Demo).
79+
How to run Python demos is explained [here][pyexamplelink].
7780

7881
### C++
7982

@@ -91,19 +94,22 @@ Only Open3D (> 0.17.0) is additionally installed for visualization purposes.
9194
make cppinstall_with_demo
9295
```
9396

94-
How to run the C++ demos is explained [here](https://github.com/url-kaist/patchwork-plusplus/tree/master/cpp).
97+
How to run the C++ demos is explained [here][cppexamplelink].
9598

9699
### ROS2
97100

98101
You should not need any extra dependency, just clone and build:
99102

100103
```commandline
101-
cd colcon_ws/src && git clone
102-
cd ../../
104+
mkdir -p ~/ros2_ws/src
105+
cd ~/ros2_ws/src
106+
git clone https://github.com/url-kaist/patchwork-plusplus.git
107+
cd ~/ros2_ws
103108
colcon build --packages-select patchworkpp
109+
source ./install/setup.bash
104110
```
105111

106-
How to launch ROS2 nodes is explained [here](https://github.com/url-kaist/patchwork-plusplus/tree/master/cpp).
112+
How to launch ROS2 nodes is explained [here][rosexamplelink].
107113

108114

109115
## :pencil: Citation

ros/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@
3434

3535
You should not need any extra dependency, just clone and build:
3636

37-
```sh
37+
```commandline
3838
mkdir -p ~/ros2_ws/src
39+
cd ~/ros2_ws/src
3940
git clone https://github.com/url-kaist/patchwork-plusplus.git
4041
cd ~/ros2_ws
4142
colcon build --packages-select patchworkpp

0 commit comments

Comments
 (0)