Ver código fonte

update readme

赵小蒙 1 ano atrás
pai
commit
9906052d6f
2 arquivos alterados com 107 adições e 28 exclusões
  1. 42 28
      README.md
  2. 65 0
      README_zh-CN.md

+ 42 - 28
README.md

@@ -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
 # 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
 
 
-2.Install the requirements
+1. **Install Magic-PDF**
 
 
-```sh
-cd Magic-PDF
-pip install -r requirements.txt
+```bash
+pip install magic-pdf[cpu] # Install the CPU version 
+or
+pip install magic-pdf[gpu] # Install the GPU version
 ```
 ```
 
 
-3.Run the command line
+2. **Usage via Command Line**
 
 
-```sh
-linux/osx
-export PYTHONPATH=.
-win
-$env:PYTHONPATH += ";.\Magic-PDF\magic_pdf"    
-```
-```
-python magic_pdf/cli/magicpdf.py --help
+```bash
+magic-pdf --help
 ```
 ```
 
 
-### 版权说明
+## License Information
 
 
-[LICENSE.md](https://github.com/magicpdf/Magic-PDF/blob/master/LICENSE.md)
+See [LICENSE.md](https://github.com/magicpdf/Magic-PDF/blob/master/LICENSE.md) for details.
 
 
-### 鸣谢
+## Acknowledgments
 
 
+- [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR)
 - [PyMuPDF](https://github.com/pymupdf/PyMuPDF)
 - [PyMuPDF](https://github.com/pymupdf/PyMuPDF)
-
-
-

+ 65 - 0
README_zh-CN.md

@@ -0,0 +1,65 @@
+<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
+
+### 简介
+
+Magic-PDF 是一款将 PDF 转化为 markdown 格式的工具。支持转换本地文档或者位于支持S3协议对象存储上的文件。
+
+主要功能包含
+
+- 支持多种前端模型输入
+- 删除页眉、页脚、脚注、页码等元素
+- 符合人类阅读顺序的排版格式
+- 提取图像和表格并在markdown中展示
+- 将公式转换成latex
+- 乱码PDF自动识别并转换
+- 支持cpu和gpu环境
+- 支持windows/linux/mac平台
+
+### 上手指南
+
+###### 配置要求
+
+python 3.9+
+
+###### 使用说明
+
+1.安装Magic-PDF
+
+```bash
+pip install magic-pdf[cpu] # 安装 cpu 版本 
+或 
+pip install magic-pdf[gpu] # 安装 gpu 版本
+```
+
+2.通过命令行使用
+
+```bash
+magic-pdf --help
+```
+
+### 版权说明
+
+[LICENSE.md](https://github.com/magicpdf/Magic-PDF/blob/master/LICENSE.md)
+
+### 鸣谢
+- [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR)
+- [PyMuPDF](https://github.com/pymupdf/PyMuPDF)
+
+