Added contributing section
This commit is contained in:
parent
0f01084405
commit
dd2dff89b4
1 changed files with 19 additions and 0 deletions
19
README.md
19
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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue