Skip to content

Commit 60c61de

Browse files
committed
docs: update README to clarify project purpose and build instructions
1 parent 11268ad commit 60c61de

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,32 @@
77

88
# webarkit-cv
99

10-
A set of tools to build a custom and light opencv lib to be used in WebAR projects. This is a WIP, but at this moment opencv_js.js can be imported as a **ES6** module.
11-
The main goal of this project is to develop a WebAR library that can be used to build a WebAR application, based on the OpenCV library.
12-
We do not reccomend to use this library in production, but if you want to try it, you can clone the project and test the examples. The API and the structure of the project can change in the future, so be aware of this.
10+
WebARKitCV is an opinionated toolchain for producing lightweight OpenCV builds tailored to WebAR workloads. It bundles the scripts, configuration, and TypeScript helpers we use to compile our fork of OpenCV into a single-file ES module (`opencv_js.js`) that runs in modern browsers and Web Workers.
11+
12+
The project currently targets OpenCV **4.12.0** (forked under `webarkit/opencv`) and **emsdk 3.1.69**. Expect breaking changes while we continue to tune the build for smaller payloads and a smoother developer experience; treat the artifacts as experimental until we cut a stable release.
13+
14+
Getting started is as simple as cloning the repo, running one of the build scripts (`build.sh` on Unix, `build_w_docker.bat` on Windows), and loading the generated example pages under `examples/` to validate your environment. Feedback and contributions are welcome—see the Issues section for discussion topics and the roadmap.
1315

1416
## Typescript
17+
1518
WebARKitCV is developed in the Typescript language; Type definitions are in the `types` folder.
1619

1720
## OpenCV and Emscripten emsdk
18-
We are using OpenCV version 4.7.0 (our modified fork) and emsdk 3.1.26
21+
22+
We are using OpenCV version 4.12.0 (our modified fork) and emsdk 3.1.69
1923

2024
### Tools
2125

22-
See the build.sh script. It will build the opencv_js.js lib and after it will copy in the build folder. We are trying to build a lighter opencv_js.js lib,
23-
So we use a config to minimize the file size. Without this the final lib will be too big in size with features that we don't need.
24-
The opencv_js.js file is based on a modified version of OpenCV that let you import the OpenCV library as a ES6 module. If you are interested read this [issue](https://github.com/kalwalt/webarkit-cv/issues/1).
26+
See the build scripts below; each one compiles the OpenCV ES module and copies it into the `build` folder. We are trying to build a lighter `opencv_js.js`, so we use a custom config to trim features we do not currently need. The module is based on our forked OpenCV tree, which adds ES module support—details live in [issue #1](https://github.com/kalwalt/webarkit-cv/issues/1).
27+
28+
### Build scripts
29+
30+
- `build.sh`: native Linux workflow that assumes `emsdk`/Emscripten is installed and on your `PATH`.
31+
- `build_w_docker.sh`: Linux/macOS workflow that wraps the build in the official Emscripten Docker image—no local `emsdk` install required.
32+
- `build_w_docker.bat`: Windows PowerShell/Command Prompt variant that uses the same Docker-based flow.
2533

2634
### Future development
2735

2836
- npm package
2937
- documentation
30-
- first WebAR example
38+
- first WebAR example

0 commit comments

Comments
 (0)