From da680bc04e1c8349e8db5197ad1bf7de57abea18 Mon Sep 17 00:00:00 2001
From: Jean-Marc MEESSEN <jean-marc@meessen-web.org>
Date: Wed, 15 Jul 2020 13:40:47 +0200
Subject: [PATCH] Improve documentation

---
 README.md             | 44 +++++++++++++++++++++++++++++++++++++++++++
 cmd/FLEcli_version.go |  2 +-
 cmd/csv.go            |  4 ++--
 todo.md               | 10 ++++++----
 4 files changed, 53 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index d54c2d3..4fe51a4 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,47 @@ Multi-platform "Fast Log Entry"(FLE) processing tool.
 This tool is intended to process FLE formated files on other platform than Windows. The FLE file format is described on https://www.df3cb.com/fle/documentation/
 
 But is also the alibi to learn and explore GO.
+
+## Usage
+
+### Installing
+Running on a Mac, Linux, windows
+
+### Commands and options
+
+```
+Usage:
+  FLEcli [command]
+
+Available Commands:
+  adif        Generates an ADIF file based on a FLE type shorthand logfile.
+  csv         Generates a SOTA .csv file based on a FLE type shorthand logfile.
+  help        Help about any command
+  load        Loads and validates a FLE type shorthand logfile
+
+Flags:
+      --config string   config file (default is $HOME/.FLEcli.yaml)
+  -h, --help            help for FLEcli
+  -i, --input string    FLE formatted input file (mandatory)
+      --interpolate     Interpolates the missing time entries.
+  -v, --version         version for FLEcli
+
+Use "FLEcli [command] --help" for more information about a command.
+````
+
+### Example: validate the FLE syntax
+
+To load and validate the FLE formated file (.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.
+
+
+### Example: generate an ADIF file
+### Example: generate an ADIF file for WWFF upload
+### Example: generate a SOTA csv file
+
+Display all the options
diff --git a/cmd/FLEcli_version.go b/cmd/FLEcli_version.go
index 71266a5..47a402d 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-6-g7d903fb (2020-07-14)"
+const VersionString = "v0.0.0.0-7-gef2d33f (2020-07-14)"
diff --git a/cmd/csv.go b/cmd/csv.go
index 22f536f..b5660fe 100644
--- a/cmd/csv.go
+++ b/cmd/csv.go
@@ -16,11 +16,11 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+//Documentation of SOTA CSV format: https://www.sotadata.org.uk/en/upload/activator/csv/info 
+
 import (
 	"fmt"
 	"github.com/spf13/cobra"
-	//	"log"
-	//"strings"
 )
 
 var outputCsvFilename string
diff --git a/todo.md b/todo.md
index 47e6164..3067688 100644
--- a/todo.md
+++ b/todo.md
@@ -6,6 +6,7 @@
 ## Test framework
 * [ ] Perform the test of the complete app
 * [ ] Improve build processing (cross compile, directory)
+* [ ] Implement continuous integration
 
 
 
@@ -19,16 +20,17 @@
 * [ ] Support date not prefixed by "date" (non header mode) DATE keyword is now optional
 * [ ] Support date increment
 * [ ] Support WWFF keyword
-* [ ] Validate that we have the necessary dat for the output 
+* [ ] Validate that we have the necessary data for the output 
 
 ## Output processing
 * [x] WWFF ADIF output
-* [ ] Standard ADIF output
-* [ ] SOTA ADIF
-* [ ] SOTA CSV
+* [x] Standard ADIF output
+* [x] SOTA ADIF
+* [x] SOTA CSV
 
 ## Later 
 * [ ] Process contest reports
 * [ ] Infer digital mode report
 * [ ] add unit test for the DefaultReport validate function
+* [ ] look how to make it work as a CGI