# MuPDF.NET

**Repository Path**: weimingtom2000/MuPDF.NET

## Basic Information

- **Project Name**: MuPDF.NET
- **Description**: Imported from https://github.com/ArtifexSoftware/MuPDF.NET
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-28
- **Last Updated**: 2024-07-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# MuPDF.NET

## About
MuPDF.NET adds C# bindings and abstractions to MuPDF, a lightweight PDF, XPS, and eBook viewer, renderer, and toolkit. Both MuPDF.NET and MuPDF are maintained and developed by Artifex Software, Inc.

## Prerequisites

While being portable to other platforms, this documentation is targeted to the Windows operating system and Visual Studio only.

- Visual Studio Community version 2019 or version 2022
- .Net v7 or later

## Generating MuPDF.NET
This is only required if you want to create a local version of the package. For creating an application that **uses** MuPDF.NET, please skip to the next section.

- Clone this repository.

- Expand folder `MuPDF.NET` and double-click on file `MuPDF.NET.sln`. This will start your Visual Studio application.

- Select `Release` and `x64` and select `Build|Solution`. Look at the window "Solution Explorer". If you see warnings like in this picture, click on "Install" as indicated to install any missing components.
![alt text](install-image.png)

- Again select `Build|Solution` and make sure the generation is successful.

- Folder `MuPDF.NET` will now contain some DLL files of which you need `mupdfcpp64.dll` and `mupdfcsharp.dll` for all your future mupdf.net applications. DLL `mupdfcpp64.dll` contains the C library MuPDF wrapped with a C++ binding, and `mupdfcsharp.dll` contains the C# bindings for MuPDF.

- Your system administration may determine to put these DLLs in a system folder or provide access to it via a `path` environment variable. If neither of this is the case, both files must be present in the project `bin` folder of your applications.

## Creating a MuPDF.NET Application

- Create a C# application using Visual Studio.

- Download and add MuPDF.NET package from [NuGet](https://www.nuget.org/packages/MuPDF.NET/2.0.5-alpha). Refer to it via instruction `using MuPDF.NET;` in your C# source.

- Code your program and build it using the VS menu items `Build|Solution`.

- The generated executable of your app is the `.exe` file in the `bin` folder.


## License and Copyright
MuPDF.NET is available under open-source [AGPL](https://github.com/ArtifexSoftware/MuPDF.NET/blob/main/LICENSE) (included in this repository as `LICENSE` file) and commercial license agreements. If you determine you cannot meet the requirements of the AGPL, please contact [Artifex](https://artifex.com/contact/) for more information regarding a commercial license.