docs(build): document SDK and VM build workflow - #443
Draft
VicMisael wants to merge 1 commit into
Draft
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.
Description
This PR adds a build guide for compiling the TotalCross SDK first and then
building the TotalCross VM and launcher.
The documentation was created while revisiting the project after several
years. It also provides a clearer onboarding path for new contributors,
including prerequisites, generated artifacts, platform-specific instructions,
and troubleshooting for common build failures.
Related Issue
Not applicable. This is a documentation-only improvement and does not
introduce a feature or fix a runtime bug.
Motivation and Context
The repository contains the required build configuration, but the complete
SDK-to-VM workflow was spread across Gradle files, CMake configuration,
platform-specific documentation, scripts, and CI workflows.
The new guide documents:
libtcvmand the native launcher;This should make it easier for returning and first-time contributors to
understand and reproduce the build process.
Benefited Devices
How Has This Been Tested?
This is a documentation-only change for TotalCross
7.2.2.The instructions were checked against the current repository configuration,
including:
TotalCrossSDK/build.gradle;TotalCrossVM/CMakeLists.txt;The following documentation validations were run:
Both commands passed.
A full SDK, native VM, Android, and iOS build matrix was not run as part of
this documentation-only change. These builds require dependency downloads and
platform-specific toolchains.
Tested Devices
No physical Android or iOS devices were used because this PR only changes
documentation.
Screenshots or Videos
Not applicable.