source: osm/applications/editors/josm/plugins/FIT/README.md@ 36282

Last change on this file since 36282 was 36265, checked in by taylor.smock, 9 months ago

See #23662: Add short section in README for non-developers

File size: 739 bytes
Line 
1README
2======
3
4The FIT plugin is written for Garmin FIT files.
5
6The `org.openstreetmap.josm.plugins.fit.lib` package does not have any
7dependency on JOSM; you should be able to import that into your code with
8no issues.
9
10## License
11This plugin is licensed under the GPLv2 or later.
12
13## Usage
14The main entry point for the library is `FitReader.read(InputStream inputStream)`.
15You _should not_ use any of the `public` constructors; they may change at any time.
16You also _should not_ use any of the `static <return> parse` methods.
17
18Non-developers can use this in JOSM by installing the plugin.
19Once installed, the standard methods of opening a file should allow the user to open FIT files.
20
21## Authors
22Taylor Smock <taylor.smock@kaart.com>
Note: See TracBrowser for help on using the repository browser.