Skip to content

Add dependency instructions #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reinecke merged 3 commits into from
Apr 2, 2021
Merged

Add dependency instructions #8

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
73309c3
Added pre-release warning and gradle instructions to README
reinecke Apr 1, 2021
d4b8f10
Added maven snippet and clarified wording in README quickstart
reinecke Apr 1, 2021
963607b
Set syntaxes in code blocks
reinecke Apr 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,22 @@ You can provide adapters for your video editing tool or pipeline as needed.
Quick-Start
-----------

You can add OpenTimelineIO as a dependency to your gradle project as:
```
<insert gradle dep>
```
> :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.

You can add OpenTimelineIO as a gradle dependency to your `build.gradle` with:

You can add OpenTimelineIO as a dependency to your maven project as:
```gradle
implementation 'io.opentimeline:opentimelineio:0.14.0-beta-1'
```
<insert maven dep>

You can add OpenTimelineIO as a maven dependency to your pom.xml with:

```xml
<dependency>
<groupId>io.opentimeline</groupId>
<artifactId>opentimelineio</artifactId>
<version>0.14.0-beta-1</version>
</dependency>
```


Expand All @@ -55,7 +63,7 @@ Building OpenTimelineIO-Java-Bindings
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/).
After installing Gradle and CMake follw these steps:

```console
```shell
git clone --recurse-submodules https://github.com/OpenTimelineIO/OpenTimelineIO-Java-Bindings

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

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

```console
```shell
gradle clean
gradle build -x test -PandroidBuild -Psdk_path=$ANDROID_HOME
```
Expand All @@ -94,7 +102,7 @@ Copy the JAR to the `libs` directory and add this to the app level `build.gradle
```groovy
android {
...

ndkVersion '22.0.7026061'

compileOptions {
Expand Down