From a552ce000aa44ef2aa654ded99b68f56179a745b Mon Sep 17 00:00:00 2001 From: Jeromos Kovacs Date: Wed, 25 Sep 2024 19:33:07 +0200 Subject: [PATCH] docs: readme --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 403aff8..c425628 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -# fit2gpx-rs +# 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://rustup.rs) -- with `cargo` from [github](https://github.com/jeromeschmied): `cargo install --locked --git "https://github.com/jeromeschmied/fit2gpx-rs"` +- 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"` - with `cargo` and `git` from [github](https://github.com/jeromeschmied): ```sh @@ -40,7 +40,9 @@ see [docs](https://docs.rs/crate/fit2gpx) or [examples](https://github.com/jerom ## Purpose This is a simple Rust library and binary for converting .FIT files to .GPX files. -A **_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 - [GPX](https://docs.fileformat.com/gis/gpx/) is an XML based format for GNSS tracks