More documentation on how to use the exporter

rbfx · Oct 11, 2023 · 9805e1c · 9805e1c
1 parent 9c76e1b
commit 9805e1c
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/Documentation~/Images/CreateExportSettings.jpg b/Documentation~/Images/CreateExportSettings.jpg
diff --git a/Documentation~/Images/ExportSettings.jpg b/Documentation~/Images/ExportSettings.jpg
diff --git a/Documentation~/README.md b/Documentation~/README.md
@@ -15,3 +15,17 @@ The project has Zenject as a dependency. To find out how to install Zenject you
 
 The main exporter package name is io.rebelfork.unityexporter. You can find it in Releases section of this github project.
 
+Use [Package Manger](https://docs.unity3d.com/Manual/upm-ui.html) to add this package to your Unity project.
+
+## Setup
+
+First you need to create ExportSettings in the assets of your project. This asset going to hold all export settings for the project.
+
+![Create export settings](Images/CreateExportSettings.jpg)
+
+When selecting the asset you'll see the following in the Inspector window:
+![Export settings](Images/ExportSettings.jpg)
+
+Path defines path to the Data folder of your project. You can use "Pick folder" button to select it from popup dialog window. "Open folder" will reveal the folder in Explorer/Finder.
+
+"Export current scene" button starts the export of the current scene and all related assets into target folder.