cyanfish/naps2
1
1
Fork 0
mirror of https://github.com/cyanfish/naps2.git synced 2024-08-16 18:50:45 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update sdk readme

Browse Source
This commit is contained in:
Ben Olden-Cooligan 2023-04-22 11:51:00 -07:00
parent 63c376ece0
commit 4937dd6730
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
NAPS2.Sdk/README.md
View File

@ -4,6 +4,33 @@
NAPS2.Sdk is a fully-featured scanning library, supporting WIA, TWAIN, SANE, and ESCL scanners on Windows, Mac, and Linux.
## Packages
NAPS2.Sdk is modular, and depending on your needs you may have to reference a different set of packages.
### Required Packages
- **[NAPS2.Sdk](https://www.nuget.org/packages/NAPS2.Sdk/)**
- Contains core scanning functionality for all platforms.
- Exactly one of:
- **[NAPS2.Images.Gdi](https://www.nuget.org/packages/NAPS2.Images.Gdi/)**
- For working with `System.Drawing.Bitmap` images. (Windows Forms)
- **[NAPS2.Images.Gtk](https://www.nuget.org/packages/NAPS2.Images.Gtk/)**
- For working with `Gdk.Pixbuf` images. (Linux)
- **[NAPS2.Images.Mac](https://www.nuget.org/packages/NAPS2.Images.Mac/)**
- For working with `AppKit.NSImage` images. (Mac)
### Optional Packages
- **[NAPS2.Sdk.Worker](https://www.nuget.org/packages/NAPS2.Sdk.Worker/)**
- For scanning with a [worker process](). (You can also [build your own]() worker.)
- **[NAPS2.Pdfium.Binaries](https://www.nuget.org/packages/NAPS2.Pdfium.Binaries/)**
- For [importing PDFs]().
- **[NAPS2.Sane.Binaries](https://www.nuget.org/packages/NAPS2.Sane.Binaries/)**
- For [using SANE drivers]() on Mac. (Linux has them pre-installed, and Windows isn't supported.)
- **[NAPS2.Tesseract.Binaries](https://www.nuget.org/packages/NAPS2.Tesseract.Binaries/)**
- For [running OCR](). (You can also use a separate Tesseract installation if you like.)
## Drivers
| | Windows | Mac | Linux |