diff --git a/README.md b/README.md index 764a8ae3..692fc506 100644 --- a/README.md +++ b/README.md @@ -78,9 +78,23 @@ git submodule update --init --recursive * Then install dependencies for development under *Add-ons* > *Dream Textures* > *Development Tools* * This will download all pip dependencies for the selected platform into `.python_dependencies` -### Tips + +### macOS 1. On Apple Silicon, with the `requirements-dream-studio.txt` you may run into an error with gRPC using an incompatible binary. If so, please use the following command to install the correct gRPC version: ```sh pip install --no-binary :all: grpcio --ignore-installed --target .python_dependencies --upgrade ``` + +# Troubleshooting + +If you are experiencing trouble getting Dream Textures running, check Blender's system console (in the top left under the "Window" dropdown next to "File" and "Edit") for any error messages. Then [search in the issues list](https://github.com/carson-katri/dream-textures/issues?q=is%3Aissue) with your error message and symptoms. + +> **Note** On macOS there is no option to open the system console. Instead, you can get logs by opening the app *Terminal*, entering the command `/Applications/Blender.app/Contents/MacOS/Blender` and pressing the Enter key. This will launch Blender and any error messages will show up in the Terminal app. + +![A screenshot of the "Window" > "Toggle System Console" menu action in Blender](docs/assets/readme-toggle-console.png) + +Features and feedback are also accepted on the issues page. If you have any issues that aren't listed, feel free to add them there! + +The [Dream Textures Discord server](https://discord.gg/EmDJ8CaWZ7) also has a common issues list and strong community of helpful people, so feel free to come by for some help there as well. + diff --git a/docs/assets/readme-toggle-console.png b/docs/assets/readme-toggle-console.png new file mode 100644 index 00000000..c65af650 Binary files /dev/null and b/docs/assets/readme-toggle-console.png differ