Skip to content

Commit fa31394

Browse files
committed
[fix] READM fix, .gitignore extended by the .pyproject.hash
1 parent 4c9e6e3 commit fa31394

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ client_secret*.json
1212
# Python good practice ignore
1313
*.egg-info/
1414
/build/
15+
.pyproject.hash

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ Be default application create [virtual python env](https://docs.python.org/3/lib
6868
```bash
6969
DISABLE_VENV=1 make install
7070
```
71+
7172
```bash
7273
DISABLE_VENV=1 make run
7374
```
@@ -132,8 +133,6 @@ python client/cli.py ocr_upload --file examples/example-mri.pdf --ocr_cache --pr
132133

133134
## Getting started with Docker
134135

135-
Note: you can use the `make install` and `make run` command to setup the Docker environment for `text-extract-api`. You can find the manual steps required to do so described below.
136-
137136
### Prerequisites
138137

139138
- Docker
@@ -146,7 +145,11 @@ git clone https://github.com/CatchTheTornado/text-extract-api.git
146145
cd text-extract-api
147146
```
148147

149-
### Setup environmental variables
148+
### Using `Makefile`
149+
You can use the `make install` and `make run` command to setup the Docker environment for `text-extract-api`. You can find the manual steps required to do so described below.
150+
151+
152+
### Manual setup
150153

151154
Create `.env` file in the root directory and set the necessary environment variables. You can use the `.env.example` file as a template:
152155

0 commit comments

Comments
 (0)