Browse Source

Completed README

Christophe Debruyne 7 years ago
parent
commit
708e18abb2
1 changed files with 19 additions and 0 deletions
  1. 19 0
      README.md

+ 19 - 0
README.md

@@ -1,2 +1,21 @@
 # downlift
 
+## Building and using the code
+
+To build the project and copy its dependencies, execute
+
+```bash
+$ mvn package
+$ mvn dependency:copy-dependencies
+```
+
+The run the downlift process, execute the following command to see the options:
+
+```bash
+$ java -jar downlift.jar -h
+```
+
+## License
+This implementation of R2RML is written by [Christophe Debruyne](http://www.christophedebruyne.be/).
+
+This code is copyrighted by [ADAPT - Trinity College Dublin](http://www.adaptcentre.ie/) and released under the [MIT license](http://opensource.org/licenses/MIT).