Move to Markdown and add Documentation #57
Merged
Conversation
This file contains 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
hb0
approved these changes
Apr 25, 2024
Moves the adoc readme to the markdown format, as only this will be processable by Kotlin KDoc. Also adds explanations on the current Cyface binary format.
muthenberg
force-pushed
the
task/LEIP-228_Enrich-README
branch
from
9ebfdfb to
6f80315
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Moves the adoc readme to the markdown format, as only this will be processable by Kotlin KDoc.
Also adds explanations on the current Cyface binary format.