Skip to content

Commit df72d4b

Browse files
Update README.md
1 parent 063661e commit df72d4b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,18 @@ When using a cloud provider, you can change the port by setting the `PORT` envir
4242

4343
An OCR engine is NOT required to run the project, though without one the returned table object will return cell numbers instead of the cell contents.
4444

45-
This project uses [tesserocr](https://github.com/sirfz/tesserocr) as the Tesseract wrapper out-of-the-box. Follow the instructions there to set up tesserocr.
45+
If you wish to skip the OCR process, **remove the tesserocr requirement from `requirements.txt`** and continue reading the "Get started" section.
4646

47-
Alternatively, use your own OCR implementation by removing the tesserocr requirement from `requirements.txt` and updating the code in `main.py` and/or `app/__init__.py` with your own implementation.
47+
This project uses [tesserocr](https://github.com/sirfz/tesserocr) as the Tesseract wrapper out-of-the-box. Follow the instructions [here](https://github.com/sirfz/tesserocr) to set up tesserocr on your system.
48+
49+
Alternatively, use your own OCR implementation by removing the tesserocr requirement from `requirements.txt` and updating the "Advanced usage" code in `main.py` with your own implementation.
4850

4951
### Get started
5052

5153
1. Make sure Python 3.7.x is installed. `❗❗❗THIS IS IMPORTANT❗❗❗`
5254
2. `Recommended:` Set up a Python 3.7 [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)
53-
3. Install the requirements (tesserocr might require extra steps, see below): `pip install -r requirements.txt`
54-
4. Run the `main.py` file
55+
3. Install the requirements (make sure you have read the "OCR setup" section above before running this command): `pip install -r requirements.txt`
56+
4. Run the `main.py` file: `python3 main.py`
5557

5658
### Flask API server
5759

0 commit comments

Comments
 (0)