Rewrite and standardize project READMEs into two-level (friendly + technical) documentation#34
Open
Inter-Raptor wants to merge 4 commits into
Open
Conversation
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
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.
Motivation
Description
README.mdinto a two-level format with a concise quickstart, five golden rules, and an extensive technical section covering boot pipeline, validation ofmeta.json/game.bin, rendering/performance and error strategies.RaptorLauncher_GameSDK/README.mdto emphasize the API source of truth (arduino_template/src/raptor_game_sdk.h), provide a two-level SDK guide, clarify optional capabilities, and add build/install/checklist guidance.RaptorLauncher_GameSDK/dependencies/README.mdto document the dependency policy, core/optional libs, and a recommendedversions.lock.mdworkflow for reproducible builds.WiFiTouchConsole,JurassicLifeand related code guides) to the same two-level structure, added SD layout expectations, behavioral notes (asynchronous scans, event-driven rendering), checklists, and hardware/profile-specific guidance.Testing
arduino_template/src/raptor_game_sdk.h,/games/<name>/meta.json, andsettings.jsonfor consistency.Codex Task