diff --git a/README.md b/README.md index 869c58c..e2dbad4 100644 --- a/README.md +++ b/README.md @@ -165,3 +165,22 @@ error: false code: "fr" ``` - View more [examples](https://github.com/ethauvin/jokeapi/blob/master/src/test/kotlin/net/thauvin/erik/jokeapi/ApiCallTest.kt#L48)... + +## Contributing + +If you want to contribute to this project, all you have to do is clone the GitHub +repository: + +```console +git clone git@github.com:ethauvin/jokeapi.git +``` + +Then use [bld](https://rife2.com/bld) to build: + +```console +cd jokeapi +./bld compile +``` + +The project has an [IntelliJ IDEA](https://www.jetbrains.com/idea/) project structure. You can just open it after all +the dependencies were downloaded and peruse the code.