Add README and technical/user documentation - #194
Open
mapitman wants to merge 1 commit into
Open
Conversation
Covers architecture (data layer, feed ingestion, downloads, playback, DI) for developers and a walkthrough with dark-mode screenshots for users, using the app's built-in starter feeds on the latest release build.
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.
Summary
README.mdwith a brief app description, build/install, and testing commandsdocs/technical-design.mdcovering architecture: navigation, data layer, feed ingestion, downloads, playback, widget, and DIdocs/user-guide.mdwith a screen-by-screen walkthrough, illustrated with dark-mode screenshots from the v0.4.0 release build using the app's built-in starter feedsTest plan
README.md,docs/technical-design.md,docs/user-guide.mdfor accuracy