This documentation is organized around decisions and tasks rather than the
installer’s source tree. If this is your first visit, choose a route below. If
something is already broken, go directly to Troubleshooting.
Choose your installation path
FastestQuick startUse the hosted installer, launch the desktop, and verify the renderer.
Review firstClone and inspectPin the repository, check every shell target, then run the local installer.
Full controlManual setupPerform the host, guest, graphics, audio, and launcher steps yourself.
01Quick startThe shortest path to a launched and verified workspace.
02InstallationRequirements, review-first route, phases, flags, updates, and removal.
03Manual installationAn auditable command-by-command setup with complete launcher behavior.
?Before you installRoot, compatibility, storage, battery, privacy, and project limits.
Operate the workspace
$Daily usageStart and stop sessions, manage files, run workloads, and back up data.
{ }ConfigurationGraphics backends, launch variables, audio, locale, fonts, and file locations.
!TroubleshootingSymptom-led checks, `ternux doctor`, safe repair, and clean reinstall paths.
--CLI referenceEvery public command, option, status behavior, and documented JSON surface.
Understand the system
→ArchitectureFollow display, audio, filesystem, process, Zink/Turnip, and VirGL paths.
∿Evidence & benchmarksInspect all captured scene values, caveats, boundaries, and reproduction steps.
?FAQDirect answers about what ternux supports, protects, and deliberately does not do.
+ContributingSubmit code, documentation, translations, issue reports, or new device evidence.
Read claims correctly
ternux keeps four evidence levels separate. This vocabulary applies across the
README, website, issue reports, and benchmark submissions.
MeasuredCaptured numeric outputA preserved command, environment, score, FPS value, or other direct measurement.
ObservedDirect non-numeric behaviorFor example, an application-reported renderer or a confirmed working path.
Reported buildA successful build reportUseful compatibility evidence, but not a runtime or performance benchmark.
UntestedNo result establishedNo affirmative compatibility or performance claim should be inferred.
Current evidence boundary: the published graphics snapshot is from one
Redmi Turbo 4 Pro. The archived renderer and all 66 glmark2 scene values show
what happened on that device, not what every Android device will produce.
Project and support
- Read the Changelog for published history.
- Read Contributing before sending a patch or device result.
- Use the security policy
for vulnerability reports rather than a public issue.
- Open a GitHub issue
for reproducible bugs, documentation gaps, and feature proposals.