Skip to content

Commit

Permalink
Merge pull request #28 from robertknight/ocrs-release-build-note
Browse files Browse the repository at this point in the history
Add stronger hint to users to build `ocrs` and `rten*` crates in release mode
  • Loading branch information
robertknight authored Feb 20, 2024
2 parents 320b0da + 5fcdcbd commit bf640a9
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion ocrs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ This crate contains the **ocrs** OCR engine as a library. See the

[main_readme]: https://github.com/robertknight/ocrs/blob/main/README.md

## Performance note

Make sure you build the `ocrs` crate and its `rten*` dependencies in **release
mode**. Debug builds of these crates will be extremely slow.

## Usage

See [examples/hello_ocr.rs](./examples/hello_ocr.rs) for a minimal example of using this library in
Expand All @@ -17,5 +22,5 @@ cd examples/
./download-models.sh

# Run OCR on an image and print the extracted text.
cargo run -r --example hello_ocr rust-book.jpg
cargo run --release --example hello_ocr rust-book.jpg
```

0 comments on commit bf640a9

Please sign in to comment.