diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 28 insertions, 5 deletions
| @@ -11,19 +11,42 @@ In order to use this program you need to have [RDFox](https://www.oxfordsemantic | |||
| 11 | RDFox is proprietary software and as such we are not able to distribute it along with our code. | 11 | RDFox is proprietary software and as such we are not able to distribute it along with our code. |
| 12 | Please refer to [this link](https://www.oxfordsemantic.tech/tryrdfoxforfree) to request a free trial. | 12 | Please refer to [this link](https://www.oxfordsemantic.tech/tryrdfoxforfree) to request a free trial. |
| 13 | 13 | ||
| 14 | This software has been developed and tested with RDFox v.4.0 | 14 | This software has been developed and tested with RDFox v.4.1 |
| 15 | 15 | ||
| 16 | ## Using the software | 16 | ## Using the software |
| 17 | 17 | ||
| 18 | TODO | 18 | We assume you followed [these steps](https://docs.oxfordsemantic.tech/getting-started.html#getting-started) in order to setup RDFox on your personal machine and in particular you know the path to the `JRDFox.jar` library that comes with the distribution. |
| 19 | 19 | ||
| 20 | ### Provide RDFox license | 20 | ### Provide RDFox license |
| 21 | 21 | ||
| 22 | TODO | 22 | The [documentation](https://docs.oxfordsemantic.tech/features-and-requirements.html#license-key), describes several ways to provide the license to RDFox. |
| 23 | 23 | ||
| 24 | ### Compiling the project | 24 | One easy way is to put your license key in a file `RDFox.lic` in `$HOME/.RDFox/`, with adeguate read permissions for the user executing the program. |
| 25 | 25 | ||
| 26 | TODO | 26 | ### Compiling and running the project |
| 27 | |||
| 28 | The project uses [sbt](https://www.scala-sbt.org/) to manage dependences. | ||
| 29 | |||
| 30 | To compile the project run the following from the base directory: | ||
| 31 | ``` | ||
| 32 | sbt compile | ||
| 33 | ``` | ||
| 34 | |||
| 35 | The project uses the sbt plugin [sbt-assembly](https://github.com/sbt/sbt-assembly) to produce a fat jar with all the required dependences. | ||
| 36 | Run the following from the base directory of the project to produce a standalone `jar` file. | ||
| 37 | ``` | ||
| 38 | sbt assembly | ||
| 39 | ``` | ||
| 40 | |||
| 41 | The output of the command will print the location of the produced jar. Execute it with | ||
| 42 | ``` | ||
| 43 | java -jar <path/to/fat.jar> [<option> ...] | ||
| 44 | ``` | ||
| 45 | |||
| 46 | Note that the fat jar file distributed with this repository excludes the RDFox as a dependency. Provided that you have the RDFox setup on your machine, you can run the program as follows | ||
| 47 | ``` | ||
| 48 | java -cp <path/to/JRDFox.jar>:<path/to/fat.jar> uk.ac.ox.cs.rsacomb.RSAComb [<option> ...] | ||
| 49 | ``` | ||
| 27 | 50 | ||
| 28 | ### Running tests and examples | 51 | ### Running tests and examples |
| 29 | 52 | ||
