Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add stronger hint to users to build ocrs and rten* crates in release mode #28

Merged
merged 1 commit into from
Feb 20, 2024
Merged

Add stronger hint to users to build ocrs and rten* crates in release mode #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion ocrs/README.md
View file
Open in desktop
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
```
Loading