Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeromos Kovacs committed Sep 25, 2024
1 parent a552ce0 commit 2cb0b68
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
# fit2gpx-rs: convert fit to gpx files efficiently, add elevation data if you'd like
# [fit2gpx-rs](https://github.com/jeromeschmied/fit2gpx-rs): convert fit to gpx files efficiently, add elevation data if you'd like

## Installation

> [!NOTE]
> soon there might also be binary releases
- have [Rust](https://rust-lang.org)
- with `cargo` from [crates.io](https://crates.io): `cargo install fit2gpx`
- with `cargo` from [github](https://github.com/jeromeschmied): `cargo install --locked --git "https://github.com/jeromeschmied/fit2gpx-rs"`
Expand All @@ -16,6 +13,9 @@ cd fit2gpx-rs
cargo install --locked --path .
```

> [!NOTE]
> soon there might also be binary releases
## Usage

### binary
Expand All @@ -41,7 +41,7 @@ see [docs](https://docs.rs/crate/fit2gpx) or [examples](https://github.com/jerom

This is a simple Rust library and binary for converting .FIT files to .GPX files.

A significantly **_faster_** alternative to the great [**_fit2gpx_**](https://github.com/dodo-saba/fit2gpx)
A **_significantly_** faster alternative to the great [**_fit2gpx_**](https://github.com/dodo-saba/fit2gpx)
with the ability to add elevation data while converting

- [FIT](https://developer.garmin.com/fit/overview/) is a GIS data file format used by Garmin GPS sport devices and Garmin software
Expand Down

0 comments on commit 2cb0b68

Please sign in to comment.