diff --git a/README.md b/README.md index c520c71..ea08723 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ A plugin for Autodesk Maya that detects and visualizes mesh intersections in the viewport. ![Sample](https://github.com/yamahigashi/MayaIntersectionMarker/blob/doc/doc/Animation.gif) +**This plugin is currently in the early stages of its development. While we strive to make it as stable and useful as possible, you may encounter issues while using it, including Maya potentially crashing.** + ## Description @@ -16,10 +18,28 @@ The Maya Intersection Marker is a plugin designed to streamline the process of c * User-friendly interface ## Installation -wip +Follow the steps below to install the Maya Intersection Marker plugin: + +1. **Download the ZIP File:** Navigate to the [Releases](https://github.com/yamahigashi/MayaIntersectionMarker/releases) page of this repository and download the latest ZIP file. + +2. **Extract the ZIP File:** Once downloaded, extract the contents of the ZIP file. + +3. **Move Files to Maya Modules Folder:** Take the extracted files and move them to the Maya modules folder, typically located at `%USERPROFILE%\Documents\maya\modules`. + +Note: `%USERPROFILE%` is an environment variable that corresponds to the current user's home directory. Make sure to check if your Maya modules folder is located in this directory. + +Additionally, the Maya modules folder can be any location that has been configured in the `MAYA_MODULE_PATH` environment variable. Ensure that this environment variable is properly set if you wish to use a custom location for your Maya modules. ## Usage -wip +Using the Maya Intersection Marker plugin is straightforward: + +1. **Select Two Meshes:** In the Maya scene, select two meshes that you want to check for intersections. + +2. **Run the Command:** After selecting the meshes, run the `intersectionMarker` command in the command line or script editor. + +This will visualize any intersections between the selected meshes directly within the viewport. + + ## Build Instructions @@ -29,7 +49,8 @@ This section is for developers who want to contribute to the project or build it * **CMake:** Used for build automation. You can download and install CMake from [here](https://cmake.org/download/). * **Embree:** A high-performance ray tracing kernel library. You can download and install Embree from [here](https://github.com/embree/embree/releases). -* **Autodesk Maya SDK:** Make sure you have the SDK installed for the version of Maya you are developing for. +* **GLM:** A header-only C++ mathematics library for graphics software. You can download and install GLM from [here](https://github.com/g-truc/glm/releases). +* **Autodesk Maya SDK:** Make sure you have the SDK installed for the version of Maya you are developing for from [here](https://aps.autodesk.com/developer/overview/maya) ### Build Steps