Skip to content

Commit f4a8a38

Browse files
authored
Merge pull request #20 from changh95/feature/polish_readme
Polish readme
2 parents 27c525b + f0490e4 commit f4a8a38

1 file changed

Lines changed: 26 additions & 26 deletions

File tree

README.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,10 @@
11
![title](./resource/project_title.png)
22

3-
## Purpose
3+
## Purpose :fire:
44

55
This repo contains a C++ project template for developing computer vision applications.
66

7-
## Dependencies
8-
9-
You need [Python3](https://www.python.org/) to use the automation scripts for project setup and build.
10-
11-
### Linux - How to use
12-
13-
```bash
14-
# Install Python 3
15-
sudo apt install python3
16-
17-
# Project setup - Install dependencies
18-
chmod u+x setup.py
19-
./setup.py --toolchain --utils --opencv 4.5.1 --opencv_contrib --eigen 3.3.9 --pcl 1.11.1 --ceres 2.0.0 --gtsam 4.0.3 --python3 --open3d
20-
21-
```
22-
23-
- You can also use the optional `--password` argument to avoid manually typing your Linux password for every internal sudo command usage.
24-
25-
### Windows - How to use
26-
27-
- For now, Windows native build is not supported. Instead, you may use [Windows Subsystems for Linux (WSL)](https://docs.microsoft.com/en-gb/windows/wsl/install-win10) to use the build scripts.
28-
29-
## Features
7+
## Features :star2:
308

319
- The project comprise a widely-used C++ project structure.
3210
- The project supports installing essential toolchains for C++ programming and debugging.
@@ -51,11 +29,33 @@ Status legend:
5129
:white_check_mark: - Partially supported / Build-only,
5230
:heavy_multiplication_x: - Not supported yet
5331

54-
## License
32+
## How to use :book:
33+
34+
>You need [Python3](https://www.python.org/) to use the automation scripts for project setup and build.
35+
36+
### Linux
37+
38+
```bash
39+
# Install Python 3
40+
sudo apt install python3
41+
42+
# Project setup - Install dependencies
43+
chmod u+x setup.py
44+
./setup.py --toolchain --utils --opencv 4.5.1 --opencv_contrib --eigen 3.3.9 --pcl 1.11.1 --ceres 2.0.0 --gtsam 4.0.3 --python3 --open3d
45+
46+
```
47+
48+
- You can also use the optional `--password` argument to avoid manually typing your Linux password for every internal sudo command usage.
49+
50+
### Windows
51+
52+
- For now, Windows native build is not supported. Instead, you may use [Windows Subsystems for Linux (WSL)](https://docs.microsoft.com/en-gb/windows/wsl/install-win10) to use the build scripts.
53+
54+
## License :bank:
5555

5656
This repo is licensed under MIT license. Click [here]([./LICENSE](https://github.com/changh95/cpp-cv-project-template/blob/main/LICENSE)) to view the license.
5757

58-
## Contributors
58+
## Contributors :sunglasses:
5959

6060
Thanks goes to these wonderful people!
6161

0 commit comments

Comments
 (0)