Skip to content

Commit 847b837

Browse files
committed
update readme
1 parent afa4272 commit 847b837

1 file changed

Lines changed: 26 additions & 14 deletions

File tree

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
---
1010

11-
[![build](https://github.com/ipitio/ocr-pdf/actions/workflows/publish.yml/badge.svg)](https://github.com/ipitio/ocr-pdf/actions/workflows/publish.yml) [![downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fipitio%2Focr-pdf%2Focr-pdf.json&query=%24.downloads&logo=github&logoColor=959da5&labelColor=333a41&label=pulls)](https://github.com/ipitio/ocr-pdf/pkgs/container/ocr-pdf) [![size](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fipitio%2Focr-pdf%2Focr-pdf.json&query=%24.size&logo=github&logoColor=959da5&label=size&labelColor=333a41&color=indigo)](https://github.com/arevindh/backage/pkgs/container/backage) [![latest](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fipitio%2Focr-pdf%2Focr-pdf.xml&query=%2Fbkg%2Fversion%5B.%2Flatest%5B.%3D%22true%22%5D%5D%2Ftags%5B.!%3D%22latest%22%5D&logo=github&logoColor=959da5&label=latest&labelColor=333a41&color=darkgreen)](https://github.com/arevindh/backage/pkgs/container/backage)
11+
[![build](https://github.com/ipitio/ocr-pdf/actions/workflows/publish.yml/badge.svg)](https://github.com/ipitio/ocr-pdf/actions/workflows/publish.yml) [![downloads](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fipitio%2Focr-pdf%2Focr-pdf.json&query=%24.downloads&logo=github&logoColor=959da5&labelColor=333a41&label=pulls)](https://github.com/ipitio/ocr-pdf/pkgs/container/ocr-pdf) [![size](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fipitio%2Focr-pdf%2Focr-pdf.json&query=%24.size&logo=github&logoColor=959da5&label=size&labelColor=333a41&color=indigo)](https://github.com/ipitio/backage/pkgs/container/backage) [![latest](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Fipitio.github.io%2Fbackage%2Fipitio%2Focr-pdf%2Focr-pdf.xml&query=%2Fbkg%2Fversion%5B.%2Flatest%5B.%3D%22true%22%5D%5D%2Ftags%5B.!%3D%22latest%22%5D&logo=github&logoColor=959da5&label=latest&labelColor=333a41&color=darkgreen)](https://github.com/ipitio/backage/pkgs/container/backage)
1212

1313
</div>
1414

@@ -39,19 +39,23 @@ It's as easy as 1, 2, 3! Get up and going in no time with these options:
3939

4040
Are you on mobile or simply want an easy and seamless experience?
4141

42-
1. Run the [Colab](https://colab.research.google.com/github/ipitio/ocr-pdf/blob/master/colab.ipynb) cell in your browser
43-
2. Follow the prompts to upload your files
42+
1. Open [Colab](https://colab.research.google.com/github/ipitio/ocr-pdf/blob/master/colab.ipynb) cell in [Chrome](https://stackoverflow.com/a/48777857)
43+
2. Run the cell and follow the prompts
4444
3. Find the OCR'd files in your [Drive](https://drive.google.com/drive/my-drive)`/ocr-pdf`
4545

4646
To add OCRmyPDF options, append them to the `run` command.
4747

48-
### Self-hosted: Prebuilt Docker Image
48+
### Self-hosted
4949

50-
If you want to skip building an image, just use mine:
50+
Do you want to run it on your own machine, but don't want to clone the repo?
5151

52-
1. Install Docker, such as with Docker Desktop
52+
1. Ensure you have Docker or Bash and cURL installed
5353
2. Make a new `pdf` folder and put your files in `pdf/todo`
54-
3. Run the following command from the parent of `pdf` to convert the files and move them into `pdf/done`
54+
3. Run one of the following commands from the parent of `pdf`
55+
56+
#### Docker Container
57+
58+
If you want to skip building an image, just use mine:
5559

5660
```bash
5761
docker run --rm \
@@ -60,13 +64,21 @@ docker run --rm \
6064
bash predict.sh pdf [OCRmyPDF options]
6165
```
6266

67+
#### Bash Script
68+
69+
Don't want to install Docker? No problem!
70+
71+
```bash
72+
curl -sSLNZ https://ipitio.github.io/ocr-pdf/src/predict.sh | bash -s -- pdf [OCRmyPDF options]
73+
```
74+
6375
## Quick Start
6476

65-
It's still easy as 1, 2, 3! You'll find the OCR'd files in `pdf/done`.
77+
It's still easy as 1, 2, 3!
6678

6779
1. Fork and clone this repo
68-
2. `cd` into it and put your files in `pdf/todo`
69-
3. Complete one of the following:
80+
2. Put your files in `pdf/todo`
81+
3. Complete one of the following from the root of the repo:
7082

7183
### Cloud: GitHub Actions Workflow
7284

@@ -84,19 +96,19 @@ To add OCRmyPDF options, edit the command in the `predict.yml` file before commi
8496

8597
### Self-hosted
8698

87-
#### Docker Compose Service
99+
#### Docker Container
88100

89-
If you want to avoid polluting your system, use Docker Compose (which is included with Docker Desktop):
101+
To avoid polluting your system, use Docker Compose (which is included with Docker Desktop):
90102

91103
```bash
92104
docker compose up
93105
```
94106

95107
To add OCRmyPDF options, edit the command in the `compose.yml` file.
96108

97-
#### Bash Install Script
109+
#### Bash Script
98110

99-
Do want to make the most out of your hardware?
111+
Do you want to make the most out of your hardware?
100112

101113
```bash
102114
bash src/predict.sh pdf [OCRmyPDF options]

0 commit comments

Comments
 (0)