diff --git a/README.md b/README.md index 465e60d..0edb347 100644 --- a/README.md +++ b/README.md @@ -64,8 +64,8 @@ To generate a WWFF-ready ADIF file: ``` ./FLEcli adif -i --wwff ON4KJM@ONFF-025920200524.txt ``` -The `--wwff` indicates the adif flavour to produce. -You can use the `--sota` switch to generate an ADIF file containing SOTA details. +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` As we didn't provide an output filename, the default output, `ON4KJM@ONFF-025920200524.adi` will be used. diff --git a/doc/whats_new.md b/doc/whats_new.md index 697d84d..8c30956 100644 --- a/doc/whats_new.md +++ b/doc/whats_new.md @@ -1,14 +1,14 @@ # What's new? -## V0.1.1 -* improved test coverage -* improved build automation -* improved release notes publication +## v0.1.1 +* Improved test coverage +* Improved build automation +* Improved release notes publication ## Previous releases -### V0.1.0 +### 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 +### v0.0.0 * Initial release diff --git a/notes/buildNotes.md b/notes/buildNotes.md index ccfd26d..fd0c6fc 100644 --- a/notes/buildNotes.md +++ b/notes/buildNotes.md @@ -2,4 +2,9 @@ * `goreleaser --snapshot --skip-publish --rm-dist` * `dist/FLEcli_darwin_amd64/FLEcli` -* `docker build -f docker/Dockerfile -t test/test dist/FLEcli_linux_arm64` \ No newline at end of file +* `docker build -f docker/Dockerfile -t test/test dist/FLEcli_linux_arm64` + +## to push a release + +* on the master branch `git tag v0.1.1` +* `git push --tag` \ No newline at end of file diff --git a/todo.md b/todo.md deleted file mode 100644 index c8eb34f..0000000 --- a/todo.md +++ /dev/null @@ -1,36 +0,0 @@ -# TODO - -## Input protocol -* [ ] document the FLE input format - -## Test & Build framework -* [ ] Perform the test of the complete app -* [-] Implement MacOS codesigning (issue #9) -* [x] Add quality badges to main page -* [x] Make a more reasonable/richer version display (issue #10) -* [x] Create standalone documentation, separate from README (issue #13) -* [x] Re-visit the release notes (far too verbose) -* [x] Implement and track code coverage - - - -## Input processing -* [ ] New MYGRID keyword -* [ ] Support different date delimiter -* [ ] Support extrapolated date -* [ ] Support date not prefixed by "date" (non header mode) DATE keyword is now optional -* [ ] Support date increment ("date +" and "date ++") -* [ ] Support WWFF keyword -* [x] Validate that we have the necessary data for the output -* [ ] Support the contest related fields - -## Output processing -* [ ] Implement CABRILLO output - - -## 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 -