Skip to content

Commit

Permalink
docs: Consolidate and improve README troubleshooting tips
Browse files Browse the repository at this point in the history
  • Loading branch information
awwaawwa committed Feb 22, 2025
1 parent 95e8662 commit 76c7bb9
Showing 1 changed file with 10 additions and 12 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,11 +98,6 @@ For different use cases, we provide distinct methods to use our program:

2. Unzip and double-click `pdf2zh.exe` to run.

> [!TIP]
>
> If you cannot open it after downloading, please install https://aka.ms/vs/17/release/vc_redist.x64.exe and try again.

</details>

<details>
Expand Down Expand Up @@ -148,13 +143,6 @@ See [documentation for GUI](./docs/README_GUI.md) for more details.
http://localhost:7860/
```

> [!TIP]
> If you cannot access Docker Hub, please try the image on [GitHub Container Registry](https://github.com/Byaidu/PDFMathTranslate/pkgs/container/pdfmathtranslate).
> ```bash
> docker pull ghcr.io/byaidu/pdfmathtranslate
> docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate
> ```
For docker deployment on cloud service:

<div>
Expand All @@ -177,6 +165,16 @@ See [Zotero PDF2zh](https://github.com/guaguastandup/zotero-pdf2zh) for more det

</details>

> [!TIP]
>
> - If you cannot open it after downloading, please install [vc_redist.x64.exe](https://aka.ms/vs/17/release/vc_redist.x64.exe) and try again.
>
> - If you cannot access Docker Hub, please try the image on [GitHub Container Registry](https://github.com/Byaidu/PDFMathTranslate/pkgs/container/pdfmathtranslate).
> ```bash
> docker pull ghcr.io/byaidu/pdfmathtranslate
> docker run -d -p 7860:7860 ghcr.io/byaidu/pdfmathtranslate
> ```
### Unable to install?
The present program needs an AI model(`wybxc/DocLayout-YOLO-DocStructBench-onnx`) before working and some users are not able to download due to network issues. If you have a problem with downloading this model, we provide a workaround using the following environment variable:
Expand Down

0 comments on commit 76c7bb9

Please sign in to comment.