dominic/FLEcli
1
0
Fork 0
mirror of https://github.com/on4kjm/FLEcli.git synced 2025-01-31 06:51:02 +01:00
Code Issues Releases Activity

documentation tweaking

Browse source
This commit is contained in:
Jean-Marc Meessen 2020-08-11 13:21:20 +02:00
parent b9d7f5a013
commit 078669a808
4 changed files with 14 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -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.

12
doc/whats_new.md
View file

@ -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

7
notes/buildNotes.md
View file

@ -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`
* `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`

36
todo.md
View file

@ -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