update readme

This commit is contained in:
赵小蒙
2024-06-20 17:17:59 +08:00
parent 756792a3f6
commit 9906052d6f
2 changed files with 109 additions and 30 deletions

View File

@@ -1,50 +1,64 @@
<div id="top"></div>
<div align="center">
[![stars](https://img.shields.io/github/stars/magicpdf/Magic-PDF.svg)](https://github.com/magicpdf/Magic-PDF)
[![forks](https://img.shields.io/github/forks/magicpdf/Magic-PDF.svg)](https://github.com/magicpdf/Magic-PDF)
[![license](https://img.shields.io/github/license/magicpdf/Magic-PDF.svg)](https://github.com/magicpdf/Magic-PDF/tree/main/LICENSE)
[![issue resolution](https://img.shields.io/github/issues-closed-raw/magicpdf/Magic-PDF)](https://github.com/magicpdf/Magic-PDF/issues)
[![open issues](https://img.shields.io/github/issues-raw/magicpdf/Magic-PDF)](https://github.com/magicpdf/Magic-PDF/issues)
[English](README.md) | [简体中文](README_zh-CN.md)
</div>
<div align="center">
</div>
# Magic-PDF
便捷、准确的将PDF转换成Markdown文档
## Introduction
Magic-PDF is a tool designed to convert PDF documents into markdown format, capable of processing files stored locally or on object storage supporting S3 protocol.
### 上手指南
Key features include:
###### 开发前的配置要求
- Support for multiple front-end model inputs
- Removal of headers, footers, footnotes, and page numbers
- Human-readable layout formatting
- Extraction and display of images and tables within markdown
- Conversion of equations into LaTeX format
- Automatic detection and conversion of garbled PDFs
- Compatibility with CPU and GPU environments
- Available for Windows, Linux, and macOS platforms
python 3.9+
## Getting Started
###### **安装步骤**
### Requirements
1.Clone the repo
- Python 3.9 or newer
```sh
git clone https://github.com/magicpdf/Magic-PDF.git
### Usage Instructions
1. **Install Magic-PDF**
```bash
pip install magic-pdf[cpu] # Install the CPU version
or
pip install magic-pdf[gpu] # Install the GPU version
```
2.Install the requirements
2. **Usage via Command Line**
```sh
cd Magic-PDF
pip install -r requirements.txt
```bash
magic-pdf --help
```
3.Run the command line
## License Information
```sh
linux/osx
export PYTHONPATH=.
win
$env:PYTHONPATH += ";.\Magic-PDF\magic_pdf"
```
```
python magic_pdf/cli/magicpdf.py --help
```
See [LICENSE.md](https://github.com/magicpdf/Magic-PDF/blob/master/LICENSE.md) for details.
### 版权说明
[LICENSE.md](https://github.com/magicpdf/Magic-PDF/blob/master/LICENSE.md)
### 鸣谢
## Acknowledgments
- [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR)
- [PyMuPDF](https://github.com/pymupdf/PyMuPDF)