From c2e1c5e193a980bea6ae823fd9329faf3db4d5c5 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Wed, 31 Jan 2024 18:03:23 -0800 Subject: [PATCH] Added contributing section --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 91c923e..8c229b5 100644 --- a/README.md +++ b/README.md @@ -158,3 +158,22 @@ will return something like: ``` See the [examples](https://github.com/ethauvin/cryptoprice/blob/master/examples/) for more details. + +## 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/cryptoprice.git +``` + +Then use [bld](https://rife2.com/bld) to build: + +```console +cd cryptoprice +./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.