maobo/cup_edit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update quickstart

Browse Source
This commit is contained in:
Nick Fisher
2025-07-03 17:17:42 +08:00
parent 4a6479c4d8
commit 92578426ac
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs.json
View File

@@ -7,7 +7,7 @@
"Getting Started", "Getting Started",
[ [
["Overview", "/"], ["Overview", "/"],
["Getting Started", "/gettingstarted"], ["Getting Started", "/getting_started"],
["Quick Start", "/quickstart"], ["Quick Start", "/quickstart"],
["Viewer", "/viewer"], ["Viewer", "/viewer"],
["Camera Manipulation", "/camera_manipulation"] ["Camera Manipulation", "/camera_manipulation"]

10
docs/quickstart.mdx
View File

@@ -1,16 +1,16 @@
# ViewerWidget Documentation # Quick Start
`ViewerWidget` is a simplified wrapper around the Thermion 3D viewer that makes it easy to display 3D models in your Flutter application. If all you need is a quick and easy route to rendering a single 3D model in your Flutter application, start with `ViewerWidget`.
## Overview This is a simplified, Flutter-only wrapper around the underlying 3D rendering API with sane defaults for most people.
`ViewerWidget` handles the setup and configuration of a Thermion viewer, including: `ViewerWidget` handles all the setup and configuration of the underlying Thermion API, including:
- Loading 3D models (glTF assets) - Loading 3D models (glTF assets)
- Configuring skyboxes and image-based lighting - Configuring skyboxes and image-based lighting
- Setting up camera positions and manipulators - Setting up camera positions and manipulators
- Managing the rendering lifecycle - Managing the rendering lifecycle
## Installation ## Setup
Follow the steps listed in [Getting Started](./getting_started) to configure your Flutter installation and project. Follow the steps listed in [Getting Started](./getting_started) to configure your Flutter installation and project.