Skip to content

Commit bf23260

Browse files
committed
improve readme about dependencies
1 parent a2bfa9c commit bf23260

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,19 @@ This project is available via Maven:
4343
<version>0.15.0</version>
4444
</dependency>
4545
```
46-
This includes a dependency to J2V8 corresponding to the current operating system (Linux, Mac OS X, Windows).
47-
If you don't need the J2V8 engine, use `graphviz-java-no-j2v8` as artifactId,
48-
if you want to include the J2V8 engine for all operating systems, use `graphviz-java-all-j2v8`.
4946

47+
`graphviz-java` contains all needed dependencies including one to `J2V8` for the current platform (Linux, Mac OS X, Windows).
48+
This should be ok for most use cases.
49+
50+
**gradle does not support this way of defining a dependency.** Gradle users have to manually add a dependency to J2V8:
51+
e.g. `com.eclipsesource.j2v8:j2v8_linux_x86_64:4.6.0`
52+
53+
Instead of `graphviz-java` there are two alternative dependencies that can be used:
54+
- `graphviz-java-all-j2v8` additionally contains dependencies to _all_ `J2V8` platforms.
55+
So the same application can run on Linux, Mac OS X and Windows.
56+
- `graphviz-java-min-deps` contains only dependencies that are absolutely necessary.
57+
All other dependencies are marked as `optional` and must added manually. See the [pom.xml](blob/master/graphviz-java-min-deps/pom.xml) for details.
58+
5059
### Logging
5160
Graphviz-java uses the [SLF4J](https://www.slf4j.org/) facade to log.
5261
Users must therefore provide a logging implementation like [LOGBack](https://logback.qos.ch/)
@@ -71,16 +80,6 @@ or [Log4j](https://logging.apache.org/log4j/2.x/)
7180
</dependency>
7281
```
7382

74-
### Dependencies
75-
- The `pom.xml` of `graphviz-java` contains all needed dependencies including one to `J2V8` for the current platform.
76-
This should be ok for most use cases.
77-
**gradle does not support this way of defining a dependency.** Gradle users have to manually add a dependency to j2v8:
78-
e.g. `com.eclipsesource.j2v8:j2v8_linux_x86_64:4.6.0`
79-
- `graphviz-java-all-j2v8` additionally contains dependencies to _all_ `J2V8` platforms.
80-
This is useful if the project is used on different platforms (Linux, Mac OS, Windows).
81-
- `graphviz-java-min-deps` contains only dependencies that are absolutely necessary.
82-
All other dependencies are marked as `optional` and must added manually. See the [pom.xml](blob/master/graphviz-java-min-deps/pom.xml) for details.
83-
8483
## API
8584
The API is separated into a mutable and immutable part.
8685
The basic usage is as follows (assuming `import static guru.nidi.graphviz.model.Factory.*`).

0 commit comments

Comments
 (0)