docs: demonstrations on recorded data; README leads with what KINAVIS is - #3
Merged
Merged
Conversation
- examples/: an unpublished kinavis-examples package with four demonstrations, each run on recorded data: receivers (seven real receivers' NMEA read or refused), gnss_jump (a real track with one injected forty-mile jump), traffic (AIS off Harlingen, CPA and TCPA of every ship), course_to_steer (the same track against a passage plan). - Data from the gpsd regression logs (BSD-2-Clause) and the Signal K server samples (Apache-2.0), with their licences beside them. - CI runs every demonstration to the end. - README: a one-line summary first, the compile error that keeps a true course out of a magnetic one, a "See it run" section, and the call for real-hardware data moved up.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Four demonstrations in
examples/(unpublishedkinavis-examples), each on recorded data from real equipment:receivers,gnss_jump,traffic,course_to_steer. Datafrom the gpsd regression logs (BSD-2-Clause) and the Signal K samples (Apache-2.0), licences beside it. CI runs every demonstration. README: one-line summary first, the compile-error example, a
See it run section, Help wanted moved up.