Skip to content

Commit

Permalink
Merge pull request #671 from awwaawwa/main
Browse files Browse the repository at this point in the history
 docs: update README.md for improved guidance and additional tips
  • Loading branch information
awwaawwa authored Feb 22, 2025
2 parents 356c982 + 09259ec commit 449f8e6
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ For details on how to contribute, please consult the [Contribution Guide](https:

<h2 id="updates">Updates</h2>

- [Feb. 22 2025] Better release CI and well-packaged windows-amd64 exe (by [@awwaawwa](https://github.com/awwaawwa))
- [Dec. 24 2024] The translator now supports local models on [Xinference](https://github.com/xorbitsai/inference) _(by [@imClumsyPanda](https://github.com/imClumsyPanda))_
- [Dec. 19 2024] Non-PDF/A documents are now supported using `-cp` _(by [@reycn](https://github.com/reycn))_
- [Dec. 13 2024] Additional support for backend by _(by [@YadominJinta](https://github.com/YadominJinta))_
Expand Down Expand Up @@ -91,11 +92,16 @@ For different use cases, we provide distinct methods to use our program:
</details>

<details>
<summary>2. Portable (w/o Python installed)</summary>
<summary>2. Windows exe</summary>

1. Download [setup.bat](https://raw.githubusercontent.com/Byaidu/PDFMathTranslate/refs/heads/main/script/setup.bat)
1. Download pdf2zh-version-win64.zip from [release page](https://github.com/Byaidu/PDFMathTranslate/releases)

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

> [!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.
2. Double-click to run.

</details>

Expand Down Expand Up @@ -142,6 +148,14 @@ 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 Down

0 comments on commit 449f8e6

Please sign in to comment.