[Brief description of what this SDK provides. Should closely match the sdkcraft.yaml description. Focus on how the SDK affects the development environment: what toolchain/runtime it provides, what it persists on the host, and any notable features. Example: "A development environment for Go projects. It provides the official Go toolchain, manages module caches via persistent mounts, and preserves Go environment settings across workshop updates."]
A minimal workshop:
# workshop.yaml
name: [workshop-name]
base: ubuntu@[version] # e.g., [email protected]
sdks:
- name: [sdk-name]
channel: [channel] # e.g., 1.24/stable
actions:
[action-name]: |
[command][One sentence explaining what this demonstrates, e.g., "This demonstrates a basic Go build workflow with persistent module caching."]
-
[List prerequisites, e.g., "This relies on the
uvSDK for venv."] -
[Suggest expected project directory structure, including source code layout and setup steps needed:]
[command to clone or prepare sources]
-
[Describe what side effects may happen during launch and refresh.]
Once the workshop is ready:
[workshop run]
[commands to perform the primary task][Explain where outputs go and how they persist across workshop updates.]
From within the workshop shell:
workshop shell
[test or run commands][Brief explanation of what this achieves.]
- Interface:
mount - Workshop target:
[/path/inside/workshop] - Purpose: [What this persists between workshop updates.]
- Interface:
gpu - Purpose: Grants access to [AMD/NVIDIA] GPU hardware on the host.
-- OR --
This SDK doesn't define any plugs.
- Interface:
mount - Workshop source:
[/path/inside/workshop] - Purpose: [What resource this exposes to other SDKs]
-- OR --
This SDK doesn't define any slots.
- [XYZ] community forum: [Link to upstream forum/community]
- Please review our Code of Conduct before participating.
All contributions, including code, documentation updates, and issue reports, are welcome!
- See CONTRIBUTING for guidelines.
- Open issues or pull requests on the official repository.
Copyright [START YEAR] [COPYRIGHT HOLDER].
[Include any required claims, information, and disclaimers for your license.]