diff --git a/README.md b/README.md index 9dbb229..25d3bce 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ --- -[![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) +[![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) @@ -39,19 +39,23 @@ It's as easy as 1, 2, 3! Get up and going in no time with these options: Are you on mobile or simply want an easy and seamless experience? -1. Run the [Colab](https://colab.research.google.com/github/ipitio/ocr-pdf/blob/master/colab.ipynb) cell in your browser -2. Follow the prompts to upload your files +1. Open [Colab](https://colab.research.google.com/github/ipitio/ocr-pdf/blob/master/colab.ipynb) cell in [Chrome](https://stackoverflow.com/a/48777857) +2. Run the cell and follow the prompts 3. Find the OCR'd files in your [Drive](https://drive.google.com/drive/my-drive)`/ocr-pdf` To add OCRmyPDF options, append them to the `run` command. -### Self-hosted: Prebuilt Docker Image +### Self-hosted -If you want to skip building an image, just use mine: +Do you want to run it on your own machine, but don't want to clone the repo? -1. Install Docker, such as with Docker Desktop +1. Ensure you have Docker or Bash and cURL installed 2. Make a new `pdf` folder and put your files in `pdf/todo` -3. Run the following command from the parent of `pdf` to convert the files and move them into `pdf/done` +3. Run one of the following commands from the parent of `pdf` + +#### Docker Container + +If you want to skip building an image, just use mine: ```bash docker run --rm \ @@ -60,13 +64,21 @@ docker run --rm \ bash predict.sh pdf [OCRmyPDF options] ``` +#### Bash Script + +Don't want to install Docker? No problem! + +```bash +curl -sSLNZ https://ipitio.github.io/ocr-pdf/src/predict.sh | bash -s -- pdf [OCRmyPDF options] +``` + ## Quick Start -It's still easy as 1, 2, 3! You'll find the OCR'd files in `pdf/done`. +It's still easy as 1, 2, 3! 1. Fork and clone this repo -2. `cd` into it and put your files in `pdf/todo` -3. Complete one of the following: +2. Put your files in `pdf/todo` +3. Complete one of the following from the root of the repo: ### Cloud: GitHub Actions Workflow @@ -84,9 +96,9 @@ To add OCRmyPDF options, edit the command in the `predict.yml` file before commi ### Self-hosted -#### Docker Compose Service +#### Docker Container -If you want to avoid polluting your system, use Docker Compose (which is included with Docker Desktop): +To avoid polluting your system, use Docker Compose (which is included with Docker Desktop): ```bash docker compose up @@ -94,9 +106,9 @@ docker compose up To add OCRmyPDF options, edit the command in the `compose.yml` file. -#### Bash Install Script +#### Bash Script -Do want to make the most out of your hardware? +Do you want to make the most out of your hardware? ```bash bash src/predict.sh pdf [OCRmyPDF options]