Skip to content

Rewrite and standardize project READMEs into two-level (friendly + technical) documentation#34

Open
Inter-Raptor wants to merge 4 commits into
mainfrom
codex/refactor-all-readme-files-with-explanations
Open

Rewrite and standardize project READMEs into two-level (friendly + technical) documentation#34
Inter-Raptor wants to merge 4 commits into
mainfrom
codex/refactor-all-readme-files-with-explanations

Conversation

@Inter-Raptor
Copy link
Copy Markdown
Owner

Motivation

  • Improve newcomer onboarding by providing a short "fun & simple" layer and a deeper "technical" layer across the project README files.
  • Make the SDK surface and expectations explicit by documenting the true public API and usage patterns for game authors.
  • Reduce confusion around optional features, dependencies and example usage by consolidating conventions, checklists and file paths.

Description

  • Rewrote the root README.md into a two-level format with a concise quickstart, five golden rules, and an extensive technical section covering boot pipeline, validation of meta.json/game.bin, rendering/performance and error strategies.
  • Reworked RaptorLauncher_GameSDK/README.md to 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.
  • Updated RaptorLauncher_GameSDK/dependencies/README.md to document the dependency policy, core/optional libs, and a recommended versions.lock.md workflow for reproducible builds.
  • Refactored example READMEs (WiFiTouchConsole, JurassicLife and 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

  • No code changes were made, so no automated unit or integration tests were applicable to these documentation updates.
  • Documentation is textual only and intended for human review, with no automated test suite executed as part of this PR.
  • Manual verification consisted of spot-checking references to key paths and filenames such as arduino_template/src/raptor_game_sdk.h, /games/<name>/meta.json, and settings.json for consistency.

Codex Task

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant