Skip to content
Snippets Groups Projects
Commit 6ac238ed authored by Moritz Bergenthal's avatar Moritz Bergenthal
Browse files

Modify description to mention dependencies

parent c2e2a976
No related branches found
No related tags found
1 merge request!35Modify description to mention dependencies
Pipeline #207122 passed
# FPTG-Library
Note this description is written in english. Sadly the author can not write well in english. So if you don't understand something pls ask.
## Java Doc
The cool thing is, we added javadoc to most classes and public methods. To access build it on your own via `````mvn javadoc:javadoc ````` or ask the authors.
## Visualisation
execute ````mvn package```` and then execute the visualisation jar.
## Short Overview
This project was created to supply a library for parametrized graph problems that can be easily extended.
So far we added the following features:
......@@ -16,11 +9,23 @@ So far we added the following features:
- and much more
## How to use
add the following maven dependency to your project:
Add the following maven dependency to your project:
````xml
<dependency>
<groupId>de.uni.bremen.grapa</groupId>
<artifactId>FPTG-Library</artifactId>
<version>main-SNAPSHOT</version>
</dependency>
````
\ No newline at end of file
````
This package is published in a [registry](https://gitlab.informatik.uni-bremen.de/groups/grapa/java/-/packages/634), where you can also find more information about how to setup both the registry as well as the dependency
## Dependencies
This project incorporates multiple open-source dependencies.
Notable dependencies are
- [Google OR-Tools](https://developers.google.com/optimization)
- [Quick Cliques](https://gitlab.informatik.uni-bremen.de/grapa/java/maxcliqueenumeration)
- [WeGotYouCovered](https://github.com/KarlsruheMIS/pace-2019/releases/tag/pace-2019)
Whereas OR-Tools are included as maven dependency, Quick Cliques and WeGotYouCovered are directly included as binaries in `src/main/resources`, where Quick Cliques corresponds to `mce_solver` and WeGotYouCovered corresponds to `vc_solver`.
Their licenses are included in the same directory and with similar names.
Those binaries are built to be run on [optil.io](https://www.optil.io/optilion/), where GLIBCv2.23 is the newest avaible GLIBC.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment