diff --git a/CMakeLists.txt b/CMakeLists.txt index 923763d..dd37c90 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -5,7 +5,7 @@ project(SlicerBoneMorphing) #----------------------------------------------------------------------------- # Extension meta-information set(EXTENSION_HOMEPAGE "https://www.slicer.org/wiki/Documentation/Nightly/Extensions/SlicerBoneMorphing") -set(EXTENSION_CATEGORY "Examples") +set(EXTENSION_CATEGORY "Morphing") set(EXTENSION_CONTRIBUTORS "Jan Heres (West Bohemian University)") set(EXTENSION_DESCRIPTION "This extensions allows the user to generate and morph bone meshes based on its CT scans") set(EXTENSION_ICONURL "https://www.example.com/Slicer/Extensions/SlicerBoneMorphing.png") diff --git a/README.md b/README.md index b47b89e..3ee143b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,35 @@ # SlicerBoneMorphing Extension for 3D Slicer for bone mesh morphing. +TODO: Explain in more depth + +## Installation +- Download the latest ZIP package from Releases +- Extract the ZIP contents to your desired folder +- Open up 3D Slicer, go to Edit -> Application Settings +- In the modules section, add the extracted contents' path to "Additional Module Paths" +- Restart 3D Slicer + + **DISCLAIMER! After restarting, the installation process will begin. If there are any Python modules not available in Slicer, they will be installed, so the startup will take SIGNIFICANTLY MORE amount of time. Do not be scared, this is intended behaviour. DISCLAIMER!** + +## Usage +After a successful install, the module will be available in the **Morphing** section. +When switching to the module, you should be greeted with the following UI: + +
+
+