|
8 | 8 | </div>
|
9 | 9 | <hr/>
|
10 | 10 |
|
| 11 | +# About |
| 12 | + |
| 13 | +This repository is for storing the completed artifacts for our Apryse SDK PDFTron-Go project at https://pkg.go.dev/github.com/pdftron/pdftron-go/v2 and managing releases. |
| 14 | + |
| 15 | +The code here is autogenerated from our PDFNetWrappers project and can be generated by following the directions available [here](https://github.com/ApryseSDK/PDFNetWrappers). |
| 16 | + |
11 | 17 | # Supported platforms: Linux , Mac, Windows <br/>
|
12 | 18 |
|
13 |
| -<strong>Environments and versions:</strong> <br/> |
| 19 | +<strong>Required environments and versions:</strong> <br/> |
14 | 20 | - <strong>Go 1.15 or greater</strong><br/>
|
15 | 21 | - <strong>Git</strong><br/>
|
16 | 22 |
|
17 |
| -# Run PDFTron Go SDK in production |
18 |
| -A commercial license key is required for use in a production environment. Please <a href="https://apryse.com/pricing">contact us to purchase a commercial license</a> if you do not have a valid license key. |
19 |
| - |
20 | 23 | # Running PDFTron Go in your project
|
21 | 24 |
|
22 |
| -1. Import `github.com/pdftron/pdftron-go/v2` into your project |
23 |
| - a. On **Windows**, you will have to locate the DLLs for running the project and append them to your path. |
24 |
| - ``` |
25 |
| - set PATH=%GOPATH%/pkg/mod/github.com/pdftron/pdftron-go/v2@your_version/shared_libs/win/Lib |
26 |
| - ``` |
27 |
| - You may also copy these directly to your project directory. |
28 |
| - |
29 |
| -2. Create a main.go in your project directory |
30 |
| - |
31 |
| -``` go |
32 |
| -package main |
33 |
| - |
34 |
| -import ( |
35 |
| - . "github.com/pdftron/pdftron-go/v2" |
36 |
| -) |
37 |
| - |
38 |
| - |
39 |
| -func main() { |
40 |
| - PDFNetInitialize("myLicenseKey:"); |
41 |
| - // do work |
42 |
| -} |
43 |
| -``` |
44 |
| - |
45 |
| -3. `go build` && run your created executable |
| 25 | +Take a look at our documentation for more information on general usage. |
46 | 26 |
|
47 |
| -# Running PDFTron Go samples |
| 27 | +https://docs.apryse.com/core/guides/get-started/go/?platform=linux |
48 | 28 |
|
49 |
| -1. Navigate to your go path where you installed the library, and search for our repository. It may be within this path based on your version of Golang. |
50 |
| - |
51 |
| -`$GOPATH/pkg/mod/github.com/pdftron/pdtron-go@version` |
52 |
| - |
53 |
| -2. Navigate to the `./samples` directory and modify the `runall_go.sh` (`runall_go.bat` on Windows) and set your `LICENSE_KEY` and if using modules such as CAD, `MODULE_PATH` to the directory where your modules are stored. |
54 |
| - |
55 |
| -3. Run the `runallgo.sh` (`runall_go.bat` on Windows). All sample tests will be run. |
56 |
| - a. If you wish to run a specific test, this can be done by specifying the test `./runall_go.sh AddImageTest` |
57 |
| - |
58 |
| - Output files will be created in `TestFiles/Output`` |
59 |
| - |
60 |
| -# Running a specific version of PDFTron Go |
61 |
| - |
62 |
| -This can be done by modifying your go.mod via this command in your project directory. |
63 |
| - |
64 |
| -``` |
65 |
| -go mod edit -require github.com/pdftron/pdftron-go/v2@v0.0.2` |
66 |
| -go mod tidy (or go get github.com/pdftron/pdftron-go/v2) |
67 |
| -``` |
68 |
| - |
69 |
| -# Project Structure |
70 |
| - |
71 |
| -The project is structured into the following |
| 29 | +# Run PDFTron Go SDK in production |
72 | 30 |
|
73 |
| -``` |
74 |
| -root - this repository |
75 |
| - source code placed in root - this contains each of the system specific source files |
76 |
| - shared_libs - this contains the Apryse SDK library files to run the go library |
77 |
| - win |
78 |
| - Lib |
79 |
| - Resources |
80 |
| - mac |
81 |
| - Lib |
82 |
| - Resources |
83 |
| - mac_arm |
84 |
| - Lib |
85 |
| - Resources |
86 |
| - linux |
87 |
| - Lib |
88 |
| - Resources |
89 |
| -``` |
| 31 | +A commercial license key is required for use in a production environment. Please <a href="https://apryse.com/pricing">contact us to purchase a commercial license</a> if you do not have a valid license key. |
90 | 32 |
|
0 commit comments