summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChris Schlaeger <cs@taskjuggler.org>2014-07-22 21:31:16 +0200
committerChris Schlaeger <cs@taskjuggler.org>2014-07-22 21:31:16 +0200
commit40d6c7daec048e939efc484083f6421a8980d224 (patch)
treef2198e490eb731fa81cfc283081f7bcce1420e9e /README.md
parent18a4d27a9e9821c217fc22601b4363c36c31d079 (diff)
downloadpostrunner-40d6c7daec048e939efc484083f6421a8980d224.zip
Put some basic information in the README file.
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 30 insertions, 10 deletions
diff --git a/README.md b/README.md
index 4d2d9f4..dc10e49 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,47 @@
-# Postrunner
+# PostRunner
-TODO: Write a gem description
+PostRunner is an application to manage FIT files such as those produced by Garmin products like the Forerunner 620. It allows you to import the files from the device and inspect them.
## Installation
-Add this line to your application's Gemfile:
+PostRunner is a Ruby application. You need to have a Ruby 2.0 or later runtime environment installed.
- gem 'postrunner'
+ $ gem install postrunner
-And then execute:
+## Usage
- $ bundle
+To get started you need to connect your device to your computer and mount it as a drive. Only devices that expose their data as FAT file system are supported. Older devices use proprietary drivers and are not supported by postrunner. Once the device is mounted find out the full path to the directory that contains your FIT files. You can then import all files on the device.
-Or install it yourself as:
+ $ postrunner import /var/run/media/user/GARMIN/GARMIN/ACTIVITY/
+
+The above command assumes that your device is mounted as /var/run/media/user. Please replace this with the path to your device. Files that have been imported previously will not be imported again.
- $ gem install postrunner
+Now you can list all the FIT files in your data base.
-## Usage
+ $ postrunner list
+
+The first column is the index you can use to reference FIT files. To get a summary of the most recent activity use the following command.
-TODO: Write usage instructions here
+ $ postrunner summary :1
+
+To get a summary of the oldest activity you can use
+
+ $ postrunner summary :-1
+
+You can also get a full dump of the content of a FIT file.
+
+ $ postrunner dump 1234568.FIT
+
+If the file is already in the data base you can also use the reference notation.
+
+ $ postrunner dump :1
+
+This will provide you with a lot more information contained in the FIT files that is not available through Garmin Connect or most other tools.
## Contributing
+PostRunner is currently work in progress. It does some things I want with files from my Garmin FR620. It's certainly possible to do more things and support more devices. Patches are welcome!
+
1. Fork it ( https://github.com/[my-github-username]/postrunner/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)