From dd2dff89b4e9a85df9f67b7ac3221c3f6281aa40 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Wed, 31 Jan 2024 18:10:06 -0800 Subject: [PATCH] Added contributing section --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 2b6f090..90eacb7 100644 --- a/README.md +++ b/README.md @@ -200,3 +200,22 @@ The API end point is automatically configured to `https://api.pinboard.in/v1/`. ```kotlin poster.apiEndPoint = "https://www.example.com/v1" ``` + +## 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/pinboard-poster.git +``` + +Then use [bld](https://rife2.com/bld) to build: + +```console +cd pinboard-poster +./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.