The project contains three modules. See the readme files for each module:
- Saul core
- Saul examples
- [Saul webapp] (saul-webapp/README.md)
The project's official chat group is at Slack
If you want to use Saul in your project, should first add it as your dependency.
Note that this is the recommended way of using it; if you don't use any
dependency management system, you can use compile it directly (next section).
Here are examples of how it is done in different dependency managment frameworks.
For each sample code, replace VERSION with the latest Saul version number.
- Maven
<repositories>
<repository>
<id>CogcompSoftware</id>
<name>CogcompSoftware</name>
<url>http://cogcomp.cs.illinois.edu/m2repo/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>edu.illinois.cs.cogcomp</groupId>
<artifactId>saul</artifactId>
<version>VERSION</version>
</dependency>
</dependencies>- SBT
resolvers += "CogcompSoftware" at "http://cogcomp.cs.illinois.edu/m2repo/"
libraryDependencies += "edu.illinois.cs.cogcomp" % "saul_2.11" % "VERSION"- Gradle
compile 'edu.illinois.cs.cogcomp:saul_2.11:VERSION'
Usually you need this options if you are developing using Saul, or you want to run the examples.
First, run sbt.
projectswill show the names of the existing module names.project saulCorewill take you inside the core package.project saulExampleswill take you inside the examples package.project saulWebappwill take you inside the webapp package. Then typerunto start the server. Typelocalhost:9000in browser address bar to see the webapp.
- Inside each project you can
compileit, orrunit. - To fix the formatting problems, run
format