diff --git a/README.md b/README.md index 15d7f8a..305f89e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # What is this? -This is the official [fSpy](https://fspy.io) import add-on for [Blender](https://blender.org). The two images below show an fSpy project (top) and a matching Blender camera created by the add-on (bottom). +This is the official [fSpy](https://fspy.io) importer add-on for [Blender](https://blender.org). The two images below show an fSpy project (top) and a matching Blender camera created by the importer (bottom). -![An example fSpy project](readme_images/help_fspy.png) +![An example fSpy project](readme_images/help_fspy.jpg) -![A matching Blender camera](readme_images/help_blender.png) +![A matching Blender camera](readme_images/help_blender.jpg) # Getting started -## 1. Downloading the latest version +## 1. Download the add-on -[Download the latest version](https://github.com/stuffmatic/fSpy-Blender/releases). Make sure you download the file called `fSpy-Blender-x.y.z.zip`. +Download the latest version from [the releases page](https://github.com/stuffmatic/fSpy-Blender/releases). Make sure you download the file called `fSpy-Blender-x.y.z.zip`. ### ⚠️ __Important note for mac users__ ⚠️ @@ -19,7 +19,7 @@ Safari seems to unzip downloaded zip archives automatically by default. Since th * Disable the auto-unzip behaviour and download the add-on again * Manually re-archive the automatically unzipped folder and point Blender to this file when installing -## 2. Installing the add-on +## 2. Install the add-on Open the preferences window by selecting Preferences from the Edit menu @@ -31,20 +31,22 @@ Select the _Add-ons_ tab and press the _Install_ button Select the downloaded zip-file and press _Install Add-on from file_ -Locate the add-on in the list and enable it by pressing the checkbox. +![Select the zip file](readme_images/help_select_zip.png) + +Locate the fSpy importer in the add-on list and enable it by pressing the checkbox. ![Enable add-on](readme_images/help_enable_addon.png) -## 3. Using the add-on +## 3. Import an fSpy project file -Once the add-on is installed and activated, fSpy project files can be imported by selecting _fSpy_ from the _Import_ menu. +Once the add-on is installed and activated, fSpy project files can be imported by selecting _fSpy_ from the _Import_ menu. This will create a camera with the same name as the imported project file. ![Import menu](readme_images/help_import_menu.png) -The importer creates a camera with the same name as the project file. - ### Import settings +At the bottom left in the importer's file browser, there is a panel with import settings. + ![Import settings](readme_images/help_import_settings.png) __Update existing import (if any)__ - If checked, any previously created camera with a name matching the project filename will be updated. If unchecked, a new camera will be created on each import. diff --git a/readme_images/help_addons_install.png b/readme_images/help_addons_install.png index b0c6058..e86b9f6 100644 Binary files a/readme_images/help_addons_install.png and b/readme_images/help_addons_install.png differ diff --git a/readme_images/help_blender.jpg b/readme_images/help_blender.jpg new file mode 100644 index 0000000..aa1e888 Binary files /dev/null and b/readme_images/help_blender.jpg differ diff --git a/readme_images/help_blender.png b/readme_images/help_blender.png deleted file mode 100644 index aff8528..0000000 Binary files a/readme_images/help_blender.png and /dev/null differ diff --git a/readme_images/help_edit_preferences.png b/readme_images/help_edit_preferences.png index f753004..5dd9a4f 100644 Binary files a/readme_images/help_edit_preferences.png and b/readme_images/help_edit_preferences.png differ diff --git a/readme_images/help_enable_addon.png b/readme_images/help_enable_addon.png index 8d4c14a..cf47a05 100644 Binary files a/readme_images/help_enable_addon.png and b/readme_images/help_enable_addon.png differ diff --git a/readme_images/help_fspy.jpg b/readme_images/help_fspy.jpg new file mode 100644 index 0000000..5ca1345 Binary files /dev/null and b/readme_images/help_fspy.jpg differ diff --git a/readme_images/help_fspy.png b/readme_images/help_fspy.png deleted file mode 100644 index 304480f..0000000 Binary files a/readme_images/help_fspy.png and /dev/null differ diff --git a/readme_images/help_import_menu.png b/readme_images/help_import_menu.png index 98d2dbf..6c711e6 100644 Binary files a/readme_images/help_import_menu.png and b/readme_images/help_import_menu.png differ diff --git a/readme_images/help_import_settings.png b/readme_images/help_import_settings.png index ec4df4b..3babc4a 100644 Binary files a/readme_images/help_import_settings.png and b/readme_images/help_import_settings.png differ diff --git a/readme_images/help_select_zip.png b/readme_images/help_select_zip.png new file mode 100644 index 0000000..9fd4db1 Binary files /dev/null and b/readme_images/help_select_zip.png differ