@@ -18,6 +18,20 @@ ICEpdf is an open source project and is always looking for more contributors. T
18
18
[ Wiki] ( https://github.com/pcorless/icepdf/wiki ) pages. Create a pull requests and use the issue tracker, the more
19
19
help and feedback we get the better we an make the project.
20
20
21
+ ### Getting the jars, javadoc and source from maven central
22
+ ``` xml
23
+ <dependency >
24
+ <groupId >com.github.pcorless.icepdf</groupId >
25
+ <artifactId >icepdf-core</artifactId >
26
+ <version >7.1.1</version >
27
+ </dependency >
28
+ <dependency >
29
+ <groupId >com.github.pcorless.icepdf</groupId >
30
+ <artifactId >icepdf-viewer</artifactId >
31
+ <version >7.1.1</version >
32
+ </dependency >
33
+ ```
34
+
21
35
## Getting the Code
22
36
To get a local copy of the current code, clone it using git:
23
37
```
@@ -30,8 +44,29 @@ $ cd icepdf
30
44
component you'll also need to build the Viewer library. The project can be built with Gradle or Maven, we have
31
45
no preference, pick which ever one makes you more happy.
32
46
33
- Builds as they are currently written work best with Java 8 but they can also be easily configured to work with JDK 11+.
34
-
47
+ Builds as they are currently configured target Java 11.
48
+
49
+ #### Building With Maven
50
+ ```
51
+ # core module
52
+ ~$ mvn -pl :icepdf-core package
53
+
54
+ # viewer module, -am insures dependencies are build
55
+ ~$ mvn -pl :icepdf-viewer -am package
56
+
57
+ # Viewer jar with all dependences in one self executing jar
58
+ ~$ mvn -pl :icepdf-viewer -am package -P assembly
59
+
60
+ # examples module, -am insures dependencies are build
61
+ ~$ mvn -pl :png-capture -am package
62
+ # or with full group id.
63
+ ~$ mvn -pl org.icepdf.examples:png-capture -am package
64
+ ~$ java -jar icepdf-viewer-7.0.0-SNAPSHOT-jar-with-dependencies.jar
65
+
66
+ # Whole project hierarchy can be built with or with full group id.
67
+ ~$ mvn package
68
+
69
+ ```
35
70
#### Building With Gradle
36
71
37
72
Build the core jar using the following Gradle command
@@ -55,24 +90,6 @@ Build the distribution zip and tar archives
55
90
~$ gradle projectReport, sourcesJar, genPomFileForCoreJarPub, genPomFileForViewerJarPub, osDistZip, osDistTar
56
91
```
57
92
58
- #### Building With Maven
59
- ```
60
- # core module
61
- ~$ mvn -pl :icepdf-core package
62
-
63
- # viewer module, -am insures dependencies are build
64
- ~$ mvn -pl :icepdf-viewer -am package
65
-
66
- # examples module, -am insures dependencies are build
67
- ~$ mvn -pl :png-capture -am package
68
- # or with full group id.
69
- ~$ mvn -pl org.icepdf.os.examples:png-capture -am package
70
-
71
- # Whole project hierarchy can be built with or with full group id.
72
- ~$ mvn package
73
-
74
- ```
75
-
76
93
## Using ICEpdf Viewer Component
77
94
The ` org.icepdf.core.ri.common.SwingController ` class provides convenience methods for the most common UI actions,
78
95
such as rotating the document, setting the zoom level, etc. The ` org.icepdf.core.ri.common.SwingViewBuilder ` class is
@@ -153,14 +170,14 @@ window.setVisible(true);
153
170
controller. openDocument(filePath);
154
171
```
155
172
156
- Make sure to take a look at the [ Wiki] ( https://github.com/pcorless/icepdf/wiki/Examples ) for more examples of extracting content.
173
+ Make sure to take a look at the [ Wiki] ( https://github.com/pcorless/icepdf/wiki/Usage- Examples ) ) for more examples of extracting content.
157
174
158
175
## Learning
159
176
160
177
### Examples
161
178
162
179
There are bunch of examples located in the root of the project grouped by common usage scenarios. Similarly the
163
- Wiki contains [ example] ( https://github.com/pcorless/icepdf/wiki/Examples ) information.
180
+ Wiki contains [ example] ( https://github.com/pcorless/icepdf/wiki/Usage- Examples ) information.
164
181
165
182
### API Documentation
166
183
0 commit comments