Skip to content

Commit b60a404

Browse files
committed
Update parent README.md file
1 parent 17e6367 commit b60a404

File tree

1 file changed

+15
-45
lines changed

1 file changed

+15
-45
lines changed

README.md

+15-45
Original file line numberDiff line numberDiff line change
@@ -45,17 +45,17 @@
4545
[examplelink]: https://github.com/url-kaist/patchwork-plusplus/tree/master/examples
4646

4747
## :package: Prerequisite packages
48-
> You may need to install Eigen, numpy, and Open3D. Open3D is used for point cloud visualization.
4948

50-
```bash
51-
# Install prerequisite packages including Open3D
52-
$ git clone https://github.com/url-kaist/patchwork-plusplus
53-
$ cd patchwork-plusplus
54-
$ bash scripts/install_open3d.bash
55-
```
49+
> [!WARNING]
50+
> Please check your cmake version via `cmake --version`. If it is lower than 3.20, please run `scripts/install_latest_cmake.bash` as follows:
51+
>
52+
> $ bash scripts/install_latest_cmake.bash
53+
>
54+
> In addition, you may need to install Eigen, numpy, and Open3D (optional). Open3D is used for point cloud visualization.
55+
5656

5757
<details>
58-
<summary> Manual Installation line-by-line </summary>
58+
<summary> Step-by-Step Installation Guide for Beginners </summary>
5959

6060
```bash
6161
# To install Eigen and numpy
@@ -77,54 +77,24 @@ $ sudo make install
7777

7878
</details>
7979

80-
## :gear: How to build
80+
## :gear: How to build & Run
8181
> Please follow below codes to build Patchwork++.
8282
83-
### Python
84-
```bash
85-
# in patchwork-plusplus directory
86-
$ cd python && pip install .
87-
```
88-
89-
### C++
90-
```bash
91-
# in patchwork-plusplus directory
92-
$ mkdir cpp/build && cd cpp/build
93-
$ cmake ..
94-
$ make
95-
```
96-
97-
## :runner: To run the demo codes
98-
> There are some example codes for your convenience!
99-
> Please try using Patchwork++ to segment ground points in a 3D point cloud :smiley:
10083

10184
### Python
10285
```bash
103-
# Run patchwork++ and visualize ground points(green) and nonground points(red)
104-
$ python examples/demo_visualize.py
105-
106-
# Run patchwork++ with sequential point cloud inputs
107-
$ python examples/demo_sequential.py
86+
make pyinstall
10887
```
10988

110-
### C++
111-
```bash
112-
# Run patchwork++ and visualize ground points(green) and nonground points(red)
113-
$ ./examples/demo_visualize
89+
Detailed installation instructions and how to run the demo are explained [here](https://github.com/url-kaist/patchwork-plusplus/tree/master/python).
11490

115-
# Run patchwork++ with sequential point cloud inputs
116-
$ ./examples/demo_sequential
91+
### C++
11792

118-
# Run patchwork++ with your point cloud file, example here
119-
$ ./examples/demo_visualize ./data/000000.bin # specify file path
93+
```bash
94+
make cppinstall
12095
```
12196

122-
### Demo Result
123-
If you execute Patchwork++ with given demo codes well, you can get the following result!
124-
125-
It is a ground segmentation result of data/000000.bin file using Open3D visualization. (Ground : Green, Nonground : Red)
126-
127-
![Open3D Visualization of "data/000000.bin"](pictures/demo_000000.png)
97+
Detailed installation instructions and how to run the demo are explained [here](https://github.com/url-kaist/patchwork-plusplus/tree/master/cpp).
12898

12999
## :pencil: Citation
130100
If you use our codes, please cite our paper ([arXiv][arXivLink], [IEEE *Xplore*][patchworkppIEEElink])

0 commit comments

Comments
 (0)