docs: align README with org template + Mermaid architecture diagram#4
Open
willwade wants to merge 2 commits into
Open
docs: align README with org template + Mermaid architecture diagram#4willwade wants to merge 2 commits into
willwade wants to merge 2 commits into
Conversation
Bring the README in line with the .github README-TEMPLATE structure used by the other Dasher frontends (Dasher-Windows et al.): standard two-sentence intro, dasher.at/feature-status/repos block, Build/Release/License badges, Status, Install, Build, Architecture, Repository layout, Contributing, License. - Architecture diagram is now a Mermaid graph (graph LR + subgraphs) instead of the one-line ASCII arrow, matching the other frontends and rendering on GitHub. Shows the Compose app + IME -> JNI shim -> DasherCore CAPI flow and the command-buffer + engine-callback return paths. - Status updated from the stale Phase 0/scaffold line to Preview, with the Play-Store-not-yet + sideload-from-Releases reality. - Repository layout converted to a table and corrected to the real at.dasher.android package (was the old org.dasherproject path) and current files (NativeBridge, DasherEngine, DasherImeService, SettingsScreen, AnalyticsService, DasherApp, LocaleHelper, ui/, etc.). - Build section now copy-pasteable (clone --recurse + gradlew assembleDebug). Signed-off-by: will wade <willwade@gmail.com>
'int[6]' inside a node label broke Mermaid - '[' starts a node shape. Quote all node labels, reword the canvas node to 'decodes the 6-int command buffer' (no brackets/arrow), and quote the draw-commands edge label. Signed-off-by: will wade <willwade@gmail.com>
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.
Brings the Android README in line with the .github README-TEMPLATE, matching what Dasher-Windows and the other frontends already do.
Changes
graph LR+ subgraphs) instead of the one-line ASCII arrow — renders on GitHub, same style as Dasher-Windows's. Shows the Compose app + IME → JNI shim → DasherCore CAPI flow, theint[]command buffer return path, and the engine callbacks (clipboard/speak/message/output/log).at.dasher.androidpackage (it referenced the oldorg.dasherproject.androidpath) and the current file set (NativeBridge, DasherEngine, DasherImeService, SettingsScreen, AnalyticsService, DasherApp, LocaleHelper, ui/, etc.); converted from an ASCII tree to a table.git clone --recurse-submodules+./gradlew :app:assembleDebug.No code changes; docs only.
DCO: commit is
Signed-off-by.