diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -12,6 +12,18 @@ $ java -jar project-checkup-0.1.4.jar +## Compiling + +Creating the JAR is as simple as doing `lein uberjar` (you probably want to use +the standalone version). + +If you want to create a binary using Graal, download Graal and run the +following: + + $ path/to/graal/native-image -jar path/to/jar -H:+ReportUnsupportedElementsAtRuntime --no-server + +You can run tests using `lein test`. + ## License Copyright © 2018 Alys Brooks