Show More
Commit Description:
Update documentation and TODO.
Commit Description:
Update documentation and TODO.
References:
File last commit:
Show/Diff file:
Action:
README.md
36 lines | 1.0 KiB | text/x-minidsrc | MarkdownLexer
36 lines | 1.0 KiB | text/x-minidsrc | MarkdownLexer
| r1 | # project-checkup | |||
| r9 | A small tool to make sure all your ducks are in a row in your project. | |||
| r1 | ||||
| r35 | If you're a relatively new Clojure programmer, you might find this interesting as it's a realistic program but isn't too complicated — there's little code and no extermal dependencies[^except]. | |||
| [^except]: The one exception is test.check, but that's only used for testing. | ||||
| r33 | ||||
| r1 | ## Installation | |||
| r18 | Download from https://bitbucket.org/alysbrooks/project-checkup/. | |||
| r1 | ||||
| ## Usage | ||||
| r16 | Run the app in the current working directory: | |||
| r1 | ||||
| r18 | $ java -jar project-checkup-0.1.4.jar | |||
| r1 | ||||
| r24 | ## 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`. | ||||
| r1 | ## License | |||
| r33 | Copyright © 2019 Alys Brooks | |||
| r1 | ||||
| Distributed under the Eclipse Public License either version 1.0 or (at | ||||
| your option) any later version. | ||||
