diff --git a/README.md b/README.md
index 1a87088..d520ada 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,5 @@
# FLEcli
+
Multi-platform "Fast Log Entry"(FLE) processing tool.
@@ -8,39 +9,39 @@ Multi-platform "Fast Log Entry"(FLE) processing tool.
The original FLE format was extented with release V1.4 to support POTA log files.
-This tool is intended to process FLE formatted files on other platform than Windows. The FLE input file format is described on https://www.df3cb.com/fle/documentation/
+This tool is intended to process FLE formatted files on other platform than Windows. The FLE input file format is described on
------
-If you like what I did and want to keep me going, you can "buy me a coffee" via the link below.
+If you like what I did and want to keep me going, you can "buy me a coffee" via the link below.
-[](https://www.buymeacoffee.com/on4kjm)
+[](https://www.buymeacoffee.com/on4kjm)
------
-
## Installing
+
The tool is installed by downloading and unpacking the archive for your operating system.
-A version is available for Windows, MacOS, Linux and ARM (RaspberryPi).
+A version is available for Windows, MacOS, Linux and ARM (RaspberryPi).
Most of them are available as 32 or 64 bit applications.
A docker version is also available.
-The releases can be downloaded from https://github.com/on4kjm/FLEcli/releases
+The releases can be downloaded from
For MacOS users, `homebrew` is the easiest installation method.
-* add the Homebrew tap with `brew tap on4kjm/tap`.
+* add the Homebrew tap with `brew tap on4kjm/tap`.
* install the application with `brew install flecli`.
+Detailed installation instructions for:
-Detailed installation instructions can be found [at this page](doc/install.md).
-
-
+* [Windows, Linux, and ARM](doc/install.md)
+* [mac](doc/install_mac.md)
## Usage
-Detailed explanations can be found [on this page](doc/usage.md).
+See [Detailed FLEcli command usage](doc/usage.md).
Most common use cases are described hereafter as examples.
@@ -48,35 +49,38 @@ Most common use cases are described hereafter as examples.
To load and validate the FLE formatted file (`myActivation.txt`):
-```
+```shell
./FLEcli load myActivation.txt
```
-This command will parse and display the QSOs in grid format.
-Fields that couldn't be successfully parsed are prefixed with "*".
-Parsing errors or doubts are listed at the end of the list.
+This command will parse and display the QSOs in grid format.
+Fields that couldn't be successfully parsed are prefixed with "*".
+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`:
-```
+```shell
./FLEcli adif -i --overwrite activation.txt output/activation.adi
```
+
The second element after the input specifies the path and name of the output file.
If is omitted, the tool will generate a filename.
It is based on the input filename, just replacing the extension with `.adi`.
-The `-o` or `--overwrite` flag indicates that, if the output file already exists, it should be overwritten.
+The `-o` or `--overwrite` flag indicates that, if the output file already exists, it should be overwritten.
The `-i` or `--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:
-```
+To generate a WWFF-ready ADIF file:
+
+```shell
./FLEcli adif -i --wwff ON4KJM@ONFF-025920200524.txt
```
+
The `--wwff` (or `-w` in the short form) indicates the adif flavour to produce.
You can also use the `--sota` switch to generate an ADIF file containing SOTA details.
The switch can be used together with `--wwff`
@@ -85,30 +89,32 @@ As we didn't provide an output filename, the default output, `ON4KJM@ONFF-025920
### Example: generate an ADIF file for POTA upload
-To generate a POTA-ready ADIF file:
-```
+To generate a POTA-ready ADIF file:
+
+```shell
./FLEcli adif -i --pota ON4KJM@ON-000120211224.txt
```
+
The `--pota` (or `-p` in the short form) indicates the adif flavour to produce.
As we didn't provide an output filename, the default output, `ON4KJM@ON-000120211224.adi` will be used.
A sample POTA FLE input file can be found in [the sample directory](test/data/sample_pota.txt).
-
### Example: generate a SOTA csv file
-To generate a CSV file that can be uploaded to https://www.sotadata.org.uk/ to report SOTA activations:
+To generate a CSV file that can be uploaded to to report SOTA activations:
-```
+```shell
./FLEcli csv --interpolate --overwrite sotaActivation.txt
```
+
or the short form
-```
+
+```shell
./FLEcli csv -i -o sotaActivation.txt
```
+
This command will generate `sotaActivation.csv` based on the `sotaActivation.txt` FLE logfile.
If the output file exists, it will be overwritten as the `--overwrite` flag has been specified.
The `--interpolate` flag will interpolate the missing non-entered times based on the first and the last entered time.
-
-
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..4c7ab55
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,10 @@
+# Documentation
+
+Project documentation
+
+## Table of Contents
+
+* [What's new](whats_new.md)
+* [Installation](install.md)
+* [Installation on a mac](install_mac.md)
+* FLEcli command [usage](usage.md)
diff --git a/doc/install.md b/doc/install.md
index ad92945..79d780b 100644
--- a/doc/install.md
+++ b/doc/install.md
@@ -2,9 +2,10 @@
## Downloading
-The application can be downloaded from the latest release page, found at https://github.com/on4kjm/FLEcli/releases.
+The application can be downloaded from the latest release page, found at .
The application is available in the following packaging:
+
* `FLEcli_v..._macOS_64-bit.tar.gz` is the MacOS version.
* `FLEcli_v..._windows_32-bit.zip` is the Windows version. Only the 32 bit is proposed as it should work also on older Windows version.
* `FLEcli_v..._Linux_64-bit.tar.gz` is the 64 bits distribution for Linux.
@@ -15,19 +16,23 @@ The application is available in the following packaging:
After downloading the appropriate archive, you can validate its sha256 and compare it with the value in the `checksum.txt` file.
## Compiling
+
The application can also be compiled from sources if Golang is available. How to proceed is out of the scope of this notice.
## Installing
-Unpack it in a convenient location. Depending on your Operating System, you can make it available from any location:
+Unpack it in a convenient location. Depending on your Operating System, you can make it available from any location:
+
* Adding the directory to the path for Windows
* Creating a (permanent) alias on Linux or MacOS
* Moving the executable to a directory that is in the path, such as `/usr/local/bin` for Linux or MacOs.
### HomeBrew
-Currently there is no Homebrew installation available.
+
+See the [installation on mac documentation](install_mac.md)
### Docker
+
The application is also available as a docker container.
It can be started with: `docker run --rm -i --user $(id -u):$(id -g) -v $(pwd):/FLEcli_data on4kjm/flecli `. If no command is specified, help is displayed.
To avoid typing the whole command, an alias is recomended as described in the [docker specific instructions](../docker/README.md).
@@ -36,6 +41,6 @@ To avoid typing the whole command, an alias is recomended as described in the [d
### MacOS
-**WARNING:** at this stage, the MacOS binary is not signed. It will fail to load on the recent OS version unless a very permissive security setting is enable (which is not advised).
+**WARNING:** at this stage, the MacOS binary is not signed. It will fail to load on the recent OS version unless a very permissive security setting is enable (which is not advised).
-Please find [here a detailed procedure](install_mac.md) to use FLEcli on a Mac despite the missing signature.
\ No newline at end of file
+Please see the [installation on a mac documentation](install_mac.md) to use FLEcli on a Mac despite the missing signature.
diff --git a/doc/install_mac.md b/doc/install_mac.md
index 6398864..a786d54 100644
--- a/doc/install_mac.md
+++ b/doc/install_mac.md
@@ -4,7 +4,7 @@
This is the easiest method.
-* add the Homebrew tap with `brew tap on4kjm/tap`.
+* add the Homebrew tap with `brew tap on4kjm/tap`.
* install the application with `brew install flecli`.
## Manual installation
@@ -15,21 +15,21 @@ This procedure will guide you for adding FLEcli to the exception list.
When the executable has been unpacked in a directory and that you try to execute it in the console (`./FLEcli`), you will get the following error:
-
+
Make sure that you choose "cancel" to close the dialog.
Having triggered that error will allow you to enable the exception.
Enter the "system preference" and choose the "Security Settings".
-
+
On the "general" tab, you will see the problem that just occurred ( _"FLEcli" was blocked from use because it is not from an identified developer_ ). Click on the "Allow Anyway" button.
-
+
When trying again to execute the application, the error message will be slightly different:
-
+
-But this time, choose "open". The exception is now registered.
\ No newline at end of file
+But this time, choose "open". The exception is now registered.
diff --git a/doc/usage.md b/doc/usage.md
index 101710b..d6738e9 100644
--- a/doc/usage.md
+++ b/doc/usage.md
@@ -1,8 +1,8 @@
# Usage
-
-
+
## Overview
-```
+
+```text
A Command Line "Fast Log Entry" (FLE) processor
Usage:
@@ -21,10 +21,10 @@ Flags:
Use "FLEcli [command] --help" for more information about a command.
```
-
-
+
## "LOAD" command
-```
+
+```text
Loads and validates a FLE type shorthand logfile
Usage:
@@ -37,10 +37,10 @@ Flags:
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
-
-
+
## "ADIF" command
-```
+
+```text
Generates an ADIF file based on a FLE type shorthand logfile.
Usage:
@@ -57,10 +57,10 @@ Flags:
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
-
-
+
## "CSV" command
-```
+
+```text
Generates a SOTA .csv file based on a FLE type shorthand logfile.
Usage:
@@ -74,10 +74,10 @@ Flags:
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
-
-
+
## "VERSION" command
-```
+
+```text
"version" will output the current build information
Usage:
@@ -90,4 +90,5 @@ Flags:
Global Flags:
--config string config file (default is $HOME/.FLEcli.yaml)
```
+
The normal output looks like `FLEcli version: v0.1.2`. The detailled output gives additionaly the Git commit hash. the date and time of build and who built the release.
diff --git a/doc/whats_new.md b/doc/whats_new.md
index c476b65..49eef4f 100644
--- a/doc/whats_new.md
+++ b/doc/whats_new.md
@@ -4,7 +4,6 @@
* Fix "S2S contacts not recognized properly" (issue #78)
-
## Previous releases
### v0.1.4
@@ -14,8 +13,6 @@
* Frequency can now be specified up to 500Hz without truncation (issue #71)
* Enabled Homebrew distribution
-
-
### v0.1.3
* Enable FLEcli to generate CSV chaser logs
@@ -33,12 +30,15 @@
* Correct some typos and bugs
### v0.1.1
+
* Improved test coverage
* Improved build automation
* Improved release notes publication
### v0.1.0
+
* First public MVP (Minimal Viable Product relase). Supports only SOTA and WWFF type log files. Some header keywords are missing as well as date increments.
### v0.0.0
+
* Initial release