You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-2Lines changed: 21 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,16 +5,35 @@ The FIT SDK documentation is available at [https://developer.garmin.com/fit](htt
5
5
## FIT SDK Developer Forum
6
6
Share your knowledge, ask questions, and get the latest FIT SDK news in the [FIT SDK Developer Forum](https://forums.garmin.com/developer/).
7
7
8
+
## FIT Java SDK Requirements
9
+
The FIT Java SDK requires the [Oracle Java Runtime Environment 8](https://www.java.com/en/download/) version 1.8.0 or higher, or equivalent in order to run the SDK tools.
10
+
11
+
In order to build or develop with the FIT Java SDK, the [Oracle Java SE 8 JDK](https://www.oracle.com/java/technologies/javase/javase8-archive-downloads.html) higher, or equivalent is required.
12
+
8
13
## Install
9
-
The latest version of the SDK can be installed from [Maven Central Repository](https://central.sonatype.com/artifact/com.garmin/fit/21.120.0)
14
+
The FIT Java SDK is published to [Maven Central Repository](https://central.sonatype.com/artifact/com.garmin/fit) and can be added to a project as a dependency.
10
15
```xml
11
16
<dependency>
12
17
<groupId>com.garmin</groupId>
13
18
<artifactId>fit</artifactId>
14
-
<version>[21.120.0,)</version>
19
+
<version>[21.176.0,)</version>
15
20
</dependency>
16
21
```
17
22
23
+
## Building Java Tools
24
+
The FIT Java SDK pom.xml file provides multiple profiles for building tools locally, such as the [FIT CSV Tool](https://developer.garmin.com/fit/fitcsvtool/).
25
+
26
+
In order to build the FIT Java SDK or its tools locally, [Apache Maven](https://maven.apache.org/what-is-maven.html) must be installed.
27
+
28
+
From the java directory, or if using custom directory names the directory containing the pom.xml file, execute the following command(s) to build the FIT Java SDK and the FIT CSV Tool. Use the -P option to only build the packages that are required.
29
+
30
+
```sh
31
+
$ mvn package -Pfitsdk # Build the FIT Java SDK
32
+
$ mvn package -Pfitcsvtool # Build the FIT CSV Tool
33
+
$ mvn package -Pfitsdk,fitcsvtool # Build both the SDK and FIT CSV Tool
34
+
```
35
+
36
+
18
37
## FIT SDK Cookbook
19
38
The [FIT SDK Cookbook](https://developer.garmin.com/fit/cookbook/) contains examples of using the FIT SDK to solve real-world problems. There are recipes for encoding and decoding Activity, Workout, and Course files; and recipes that provide tips for working with the FIT SDK.
0 commit comments