Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
julian.pieles committed Apr 28, 2023
1 parent 79e335c commit 1b9f8a2
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 1 deletion.
3 changes: 3 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
LICENSE
README.md
screenshot.png
32 changes: 31 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,33 @@
# OCRmyPDFonWEB

Streamlit Web UI for OCRmyPDF
Streamlit Web UI for OCRmyPDF. Its codebase is tiny, so if you want to modify it, it should be straightforward. It is also stateless, making it easy to deploy. No volumes. No configuration.

![screenshot](screenshot.png "Screenshot")

## Requirements

* docker

## Usage

```
docker run --rm -p 127.0.0.1:8501:8501 razemio/ocrmypdfonweb
```

## Develop

```
docker build -t razemio/ocrmypdfonweb:dev . # Only needed after you changed requirements.txt
docker run --rm -it -p 127.0.0.1:8501:8501 -v ${PWD}/server.py:/app/server.py razemio/ocrmypdfonweb
```

Happy coding :)

## FAQ

### Why?

To keep your non-tech significant other happy. The terminal can be a dark place for some people.

### Why do you use OCRmyPDF version 12.7.2?
It is the last version which supports remove background. Which is somewhat impossible to find in normal PDF editors. Otherwise, OCRmyPDF works flawlessly, and I yet haven't found an issue which makes me want to upgrade.
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1b9f8a2

Please sign in to comment.