From 731ad58ae340c74133f117d6f753ffb228ce4b30 Mon Sep 17 00:00:00 2001 From: Jean-Marc MEESSEN Date: Wed, 15 Jul 2020 23:02:31 +0200 Subject: [PATCH] Update documentation (WIP) --- README.md | 29 ++++++++++++++++++++++++++--- cmd/FLEcli_version.go | 2 +- 2 files changed, 27 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4fe51a4..ae0d00e 100644 --- a/README.md +++ b/README.md @@ -38,15 +38,38 @@ Use "FLEcli [command] --help" for more information about a command. To load and validate the FLE formated file (.txt): ->./FLEcli load -i=ON4KJM@ONFF-025920200524.txt - +``` +./FLEcli load -i=ON4KJM@ONFF-025920200524.txt +``` This command will parse and display the QSOs in grid format. Fields that couldn't be succesfuly parsed are prefixed with "*". -Parsing errors or doubts are listed at the end of the display. +Parsing errors or doubts are listed at the end of the list. ### Example: generate an ADIF file + +To generate an ADIF file based on `activation.txt`: + +``` +./FLEcli adif -i activation.txt -o output/activation.adi --overwrite --interpolate +``` +The `-o` (or the long form, `--output`) specifies the path and name of the output file. +If the flag and value are omitted, the tool will generate a filename. +It is based on the input filename, just replacing the extention with `.adi`. + +The `--overwrite` flag indicates that, if the output file already exsist, it should be overwritten. + +The `--interpolate` flag will interpolate the missing non-entered times based on the first and the last entered time. + ### Example: generate an ADIF file for WWFF upload + +To generate a WWFF ready ADIF file: +``` +./FLEcli adif -i activation.txt -o output/activation.adi --wwff --interpolate +``` +The `--wwff` indicates the adif flavour to produce. + + ### Example: generate a SOTA csv file Display all the options diff --git a/cmd/FLEcli_version.go b/cmd/FLEcli_version.go index 47a402d..ac2ccdd 100644 --- a/cmd/FLEcli_version.go +++ b/cmd/FLEcli_version.go @@ -1,4 +1,4 @@ package cmd //VersionString is the version that will be displayed with the -v switch -const VersionString = "v0.0.0.0-7-gef2d33f (2020-07-14)" +const VersionString = "v0.0.0.0-8-gda680bc (2020-07-15)"