Skip to content

Commit 30551a4

Browse files
ginicrdziewietin
andauthored
Update README.md
Co-authored-by: rdziewietin <[email protected]>
1 parent ca1edab commit 30551a4

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ Use these steps for setting up a development environment to install and work wit
2121
2) Activate your virtual environment.
2222
3) Install the package.
2323
- **Only base package**: If you want to just use the scripts and package features, install the project by running `pip install .` from the root directory.
24-
- **Package with Streamlit app**: To also install dependencies for the Streamlit frontend application, run `pip install .[app]`.
24+
- **Package with Streamlit app**: To also install dependencies for the Streamlit frontend application using the main LLM OCR, run `pip install .[app]`.
25+
- **Package with DocTR app**: To install dependencies for the Streamlit frontend application using the DocTR OCR, run `pip install .[app-doctr]`.
2526
- **All development dependencies**: If you will be changing the code and running tests, you can install it by running `pip install -e '.[app,test,dev]'`. The `-e/--editable` flag means local changes to the project code will always be available with the package is imported. You wouldn't use this in production, but it's useful for development. *PS*: use `pip install -e '.[app,test,dev]'` with the quote symbols for zshell/zsh (default shell on newer Macs).
2627

2728
For example, if you use the 'venv' Virtualenv module, you would do the following to create an environment named `venv` with Python version 3.10, then activate it and install the package in developer mode:

0 commit comments

Comments
 (0)