Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix example section of readme and delete empty example folder #87

Merged
merged 1 commit into from
Jan 29, 2025

Conversation

riley-kinahan
Copy link
Collaborator

The current version of the readme has two examples, both of which rely on a InputFileStream class which does not exist within the current version of novatel_edie. This pull request replaces those examples short explanations and links to working examples from the ./examples/ folder.

It also deletes the ./examples/novatel/rangecmp/ folder which is empty save for a CMake file, and appears to have been superseded by the ./examples/novatel/range_decompressor/ folder.

gitignore updates

Update readme

more readme updates

Clarify descriptions

Fix spacing

undo gitignore changes
Copy link
Collaborator

@jonathanmcdermid jonathanmcdermid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. I'm ambivalent on whether or not we need a description for every example in the readme, but I agree with removing the code examples from it.

@riley-kinahan riley-kinahan merged commit 5c3a04d into main Jan 29, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants