Add FAQ for questions

master
Jerome Wu 5 years ago
parent ef4fd6c61f
commit b6e4f30967
  1. 3
      README.md
  2. 8
      docs/faq.md
  3. 0
      docs/images/demo.gif

@ -13,7 +13,7 @@
Tesseract.js is a javascript library that gets words in [almost any language](./docs/tesseract_lang_list.md) out of images. ([Demo](http://tesseract.projectnaptha.com/))
[![fancy demo gif](./docs/demo.gif)](http://tesseract.projectnaptha.com)
[![fancy demo gif](./docs/images/demo.gif)](http://tesseract.projectnaptha.com)
Tesseract.js works with script tags, [webpack](https://webpack.js.org/), and [Node.js](https://nodejs.org/en/). [After you install it](#installation), using it is as simple as
@ -80,6 +80,7 @@ or
* [Image Format](./docs/image-format.md)
* [API](./docs/api.md)
* [Local Installation](./docs/local-installation.md)
* [FAQ](./docs/faq.md)
# Contributing

@ -0,0 +1,8 @@
FAQ
===
## How does tesseract.js download and keep \*.traineddata?
When you execute recognize() function (ex: `recognize(image, 'eng')`), the language model to download is determined by the 2nd argument of recognize(). (`eng` in the example)
Tesseract.js will first check if \*.traineddata already exists. (browser: [IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API), Node.js: fs, in the folder you execute the command) If the \*.traineddata doesn't exist, it will fetch \*.traineddata.gz from [tessdata](https://github.com/naptha/tessdata), ungzip and store in IndexedDB or fs, you can delete it manually and it will download again for you.

Before

Width:  |  Height:  |  Size: 97 KiB

After

Width:  |  Height:  |  Size: 97 KiB

Loading…
Cancel
Save