Skip to content

Commit 9893ef4

Browse files
authored
Add dependency instructions (#8)
* Added pre-release warning and gradle instructions to README * Added maven snippet and clarified wording in README quickstart * Set syntaxes in code blocks
1 parent 40b0eb4 commit 9893ef4

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,22 @@ You can provide adapters for your video editing tool or pipeline as needed.
3838
Quick-Start
3939
-----------
4040

41-
You can add OpenTimelineIO as a dependency to your gradle project as:
42-
```
43-
<insert gradle dep>
44-
```
41+
> :warning: **This is pre-release software**: We're releasing these bindings to encourage feedback and participation, but we expect that there may be some breaking changes along the way. Please consider this if you decide to use the bindings in their current state.
42+
43+
You can add OpenTimelineIO as a gradle dependency to your `build.gradle` with:
4544

46-
You can add OpenTimelineIO as a dependency to your maven project as:
45+
```gradle
46+
implementation 'io.opentimeline:opentimelineio:0.14.0-beta-1'
4747
```
48-
<insert maven dep>
48+
49+
You can add OpenTimelineIO as a maven dependency to your pom.xml with:
50+
51+
```xml
52+
<dependency>
53+
<groupId>io.opentimeline</groupId>
54+
<artifactId>opentimelineio</artifactId>
55+
<version>0.14.0-beta-1</version>
56+
</dependency>
4957
```
5058

5159

@@ -55,7 +63,7 @@ Building OpenTimelineIO-Java-Bindings
5563
OpenTimelineIO-Java-Bindings have been built and tested on Ubuntu 18.04LTS, Windows 10 and macOS using [Gradle](https://gradle.org/install/) and [CMake](https://cmake.org/download/).
5664
After installing Gradle and CMake follw these steps:
5765

58-
```console
66+
```shell
5967
git clone --recurse-submodules https://github.com/OpenTimelineIO/OpenTimelineIO-Java-Bindings
6068

6169
cd otio-java
@@ -80,7 +88,7 @@ You can find `sdkmanager` in `$ANDROID_HOME/tools/bin/`. `$ANDROID_HOME` is the
8088

8189
Set the `ANDROID_HOME` environment variable and from the root directory of the project run:
8290

83-
```console
91+
```shell
8492
gradle clean
8593
gradle build -x test -PandroidBuild -Psdk_path=$ANDROID_HOME
8694
```
@@ -94,7 +102,7 @@ Copy the JAR to the `libs` directory and add this to the app level `build.gradle
94102
```groovy
95103
android {
96104
...
97-
105+
98106
ndkVersion '22.0.7026061'
99107
100108
compileOptions {

0 commit comments

Comments
 (0)