Note: We are currently in the process of documenting the API. This is work-in-progress and still incomplete.

Introduction

The Silk Link Discovery Framework is written in the Scala programming language, which is a modern language for the Java virtual machine. Therefore you need Java 5 or higher for developing and using the Silk API.

The current Scaladoc can be found here.

TODO: add some general introduction here

Getting started

There a serveral ways you can use the Silk API in your project:

1. Using the Maven build system
2. By using the silk.jar which is included in every release.
3. By downloading the current source code

We recommend using the first option.

Using the Silk API with Maven

1. Download the current source code using git:
   

   git clone git://git.assembla.com/silk.git

   Instructions on installing git on different operating system can be found here.
   
   
2. Navigate to the silk2 folder and install the Silk API using Maven:
   

   mvn install

3. Now you can use the Silk API in your Maven project by declaring a dependency:
   

   <dependency>
     <groupId>de.fuberlin.wiwiss.silk</groupId>
     <artifactId>silk-core</artifactId>
     <version>2.5</version>
   </dependency>