Skip to content

Commit 0422b69

Browse files
committed
update readme
1 parent 72cf6fb commit 0422b69

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ camera perspective using ray-plane intersections and camera modeling. It feature
88
- A command-line interface for estimating object sizes from user input
99
- Unit tests to verify the implementation
1010

11+
The `core` folder contains all the logic related to the geometric size estimation,
12+
while the rest of the project is dedicated to providing utility/test scripts to use it.
13+
Most user should only use the `cli` folder to estimate object sizes from the command line
14+
or the `fps_demo` folder to visualize and interact in an fps-like environment (instructions below).
15+
Advanced user might create custom scripts that leverage functions from the `core` folder.
16+
1117
---
1218

1319
## Examples

0 commit comments

Comments
 (0)