Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
kalwalt committed Nov 26, 2022
1 parent 2163d6d commit 9e9bc82
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,9 @@ This project is quite experimental so do not expect great results. More classes

### Useful functions

At the moment only `load_jpeg_data` function to load a jpeg file and get important jpeg data (width, height, dpi and raw data).
At the moment you can try `load_jpeg_data` function to load a jpeg file and get important jpeg data (width, height, dpi and raw data).
See grayscale_example or grayscale_m_example to see the function in action.
Try `yape06_detect` function as a compact version for the yape06 detect routine. See it in action in the yape06_detect_video_example.html

## Libs
Libs are stored in `build` folder:
Expand Down Expand Up @@ -90,6 +91,7 @@ Take a look at our examples in the examples folder:
- resample_video_example.html
- sample_orb_mixed.html
- yape06_video_example.html
- yape06_detect_video_example.html

Both examples use the debug version of the lib but, of course you can use the non-debug version as well.

Expand All @@ -103,4 +105,7 @@ For the first time run:
this will build all the libs. After that if you need to compile and build only jsfeat libs:
`./build.sh emscripten`
and the two libs will be compiled in the build directory.

If you run under Windows use the `./build.Unix.sh` script instead.

We used emsdk 3.1.20.

0 comments on commit 9e9bc82

Please sign in to comment.