diff --git a/docs.json b/docs.json index 9450e418..3b9b39cd 100644 --- a/docs.json +++ b/docs.json @@ -7,6 +7,7 @@ "Getting Started", [ ["Overview", "/"], + ["Getting Started", "/gettingstarted"], ["Quick Start", "/quickstart"], ["Viewer", "/viewer"], ["Camera Manipulation", "/camera_manipulation"] diff --git a/docs/getting_started.mdx b/docs/getting_started.mdx new file mode 100644 index 00000000..371cc4b3 --- /dev/null +++ b/docs/getting_started.mdx @@ -0,0 +1,40 @@ +## Getting Started + +Thermion currently requires the Flutter `master` channel with the `native-assets` experiment enabled. + +1. Switch to Flutter master channel, upgrade Flutter, create a new project, then add `thermion_flutter` as a dependency + +```bash +$ flutter channel master +$ flutter upgrade +$ flutter config --enable-native-assets +$ cd your_flutter_project +$ flutter pub add thermion_flutter +``` + +2. If running on iOS or MacOS, change the minimum deployment target to OSX 13 + + + +Make sure the `platform` entry refers to `13.0` in your Podfile. + +In `macos/Podfile` (for macOS): +``` +platform :osx, '13.0' +``` + +In `ios/Podfile`, (for iOS): +``` +platform :ios, '13.0' +``` + +Then open XCode: +``` +open macos/Runner.xcworkspace +``` + +and change the minimum deployment target to 13.0: + +![XCode screenshot](images/macos_min_deployment.png) + + \ No newline at end of file diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 5863d036..1d33c20a 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -12,12 +12,7 @@ ## Installation -First, make sure you have the Thermion Flutter plugin added to your dependencies: - -```yaml -dependencies: - thermion_flutter: ^latest_version -``` +Follow the steps listed in [Getting Started](./gettingstarted) to configure your Flutter installation and project. ## Basic Usage diff --git a/docs/viewer.mdx b/docs/viewer.mdx index 0954d530..2d358b84 100644 --- a/docs/viewer.mdx +++ b/docs/viewer.mdx @@ -1,43 +1,14 @@ -## Quickstart (Flutter) +## ThermionViewer (Flutter) + +If you just want to display a 3D object in the viewport with some basic camera controls, use the [ViewerWidget described in the Quickstart section](./quickstart). + +If you need want more fine-grained control > You can find the entire project below in the [examples/flutter/viewer](https://github.com/nmfisher/thermion/tree/master/examples/flutter/viewer) folder of the repository. -1. Switch to Flutter master channel, upgrade Flutter, create a new project, then add `thermion_flutter` as a dependency -```bash -$ flutter channel master -$ flutter upgrade -$ flutter config --enable-native-assets -$ flutter create thermion_sample_project && cd thermion_sample_project -$ flutter pub add thermion_flutter -``` -2. If running on iOS or MacOS, change the minimum deployment target to OSX 13 - - -Make sure the `platform` entry refers to `13.0` in your Podfile. - -In `macos/Podfile` (for macOS): -``` -platform :osx, '13.0' -``` - -In `ios/Podfile`, (for iOS): -``` -platform :ios, '13.0' -``` - -Then open XCode: -``` -open macos/Runner.xcworkspace -``` - -and change the minimum deployment target to 13.0: - -![XCode screenshot](images/macos_min_deployment.png) - - 2. Add a folder containing your assets (glTF model + skybox ktx) to your `pubspec.yaml` asset list