Started documentation

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")

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: 
+
+<p align="center"> 
+<img src="docs/assets/ui.png" width="400px" height="900px">
+</p>
+
+The UI consists of **4** main modules
+- Input
+- Preprocessing
+- BCPD
+- Postprocessing
+
+## Module sections
+
+### Input
+This section is self-explanatory. Here, you choose which mesh will be 
+
+
+
+

SlicerBoneMorphing/Resources/UI/SlicerBoneMorphing.ui

@@ -7,7 +7,7 @@
     <x>0</x>
     <y>0</y>
     <width>564</width>
-    <height>1522</height>
+    <height>1257</height>
    </rect>
   </property>
   <layout class="QVBoxLayout" name="verticalLayout">
@@ -97,10 +97,10 @@
       <string>Preprocessing parameters</string>
      </property>
      <property name="checked">
-      <bool>true</bool>
+      <bool>false</bool>
      </property>
      <property name="collapsed">
-      <bool>false</bool>
+      <bool>true</bool>
      </property>
      <layout class="QFormLayout" name="formLayout_16">
       <item row="0" column="0" colspan="2">
@@ -307,10 +307,10 @@
       <string>BCPD parameters</string>
      </property>
      <property name="checked">
-      <bool>true</bool>
+      <bool>false</bool>
      </property>
      <property name="collapsed">
-      <bool>false</bool>
+      <bool>true</bool>
      </property>
      <layout class="QFormLayout" name="formLayout_2">
       <item row="0" column="0">
@@ -1107,7 +1107,7 @@
       <string>Postprocessing parameters</string>
      </property>
      <property name="checked">
-      <bool>true</bool>
+      <bool>false</bool>
      </property>
      <layout class="QFormLayout" name="formLayout_19">
       <item row="0" column="0">

metadata.s4ext

@@ -0,0 +1,5 @@
+# This is a comment
+metadataname This is the value associated with 'metadataname'
+
+# This is an other comment
+anothermetadata This is the value associated with 'anothermetadata'