From 23fd735a0d58b00ddcd88fbd6c5f0a9f83953af6 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Wed, 31 Jan 2024 18:07:01 -0800 Subject: [PATCH] Added contributing section --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 00926a6..6bf38a6 100644 --- a/README.md +++ b/README.md @@ -119,3 +119,22 @@ akismet.submitSpam(Akismet.jsonComment(json)) ### More… If all else fails, there's always more [Documentation](https://ethauvin.github.io/akismet-kotlin/). + +## 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/akismet-kotlin.git +``` + +Then use [bld](https://rife2.com/bld) to build: + +```console +cd akismet-kotlin +./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.