Skip to content

Commit

Permalink
Add jitpack instructions to README.md
Browse files Browse the repository at this point in the history
For issue #82
  • Loading branch information
philburk authored Apr 11, 2023
1 parent 2b7829d commit 40a4109
Showing 1 changed file with 30 additions and 4 deletions.
34 changes: 30 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,34 @@ The JSyn source code is available at:

https://github.com/philburk/jsyn

## Using JSyn in Your Project

If your project is not using gradle then build or [download](https://github.com/philburk/jsyn/releases)
the JSyn jar file and add it to your classpath. See Build section below.

If you are using gradle then you can simply add a dependency on JSyn to your project.
The easiest way is to use jitpack to add the latest release from GitHub.

For Groovy gradle files use:

repositories {
maven { url "https://jitpack.io" }
}

dependencies {
implementation "com.github.philburk:jsyn:latest.release"
}

The syntax is slightly different if you are using ".kts" files.

repositories {
maven { url = uri("https://jitpack.io") }
}

dependencies {
implementation("com.github.philburk:jsyn:latest.release")
}

## Building JSyn

You can build JSyn using either Ant or Gradle.
Expand All @@ -33,7 +61,7 @@ The resulting jar will be placed in "dist/lib/".

To run the built-in test App on a desktop, enter something like this:

java -jar dist/lib/jsyn-20160203.jar
java -jar dist/lib/jsyn-20230410.jar

but with the correct date.

Expand All @@ -51,7 +79,7 @@ Enter:
The resulting jar will be placed in "build/libs/".
To run the built-in test App on a desktop, enter something like this:

java -jar build/libs/jsyn-17.0.0-SNAPSHOT.jar
java -jar build/libs/jsyn-17.1.0.jar

but with the correct version.

Expand All @@ -61,5 +89,3 @@ To run the unit tests, enter:

cd jsyn
./gradlew test

JSyn - Copyright 1997 Mobileer Inc

0 comments on commit 40a4109

Please sign in to comment.