DOC: Tweak formatting of README and DeveloperGuide

* Use "atx" style of section headers
* Remove empty "Usage" section
* Use "wrench" emoji when referencing the corresponding icon in the Slicer toolbar

Author: jcfr

DeveloperGuide.md

@@ -1,10 +1,8 @@
-Information for developers
-==========================
+# Information for developers
 
 This Slicer extension is in active development. The API may change from version to version without notice.
 
-Build instructions
-------------------
+## Build instructions
 
 - Build the extension against the newly built Slicer with Qt5 and VTK9 enabled.
 - To start Slicer from a build tree and ensure the extension is properly loaded, considering using the ``--launcher-additional-settings`` option:
@@ -21,8 +19,7 @@ Alternatively, to avoid the need to specify additional command-line parameters,
 
 Note that specifying the top-level build directory of the extension ensures that Slicer find all types of modules.
 
-Useful Python Snippets
-----------------------
+## Useful Python Snippets
 
 Activate virtual reality view:
 

README.md

@@ -1,5 +1,4 @@
-SlicerVirtualReality
-====================
+# SlicerVirtualReality
 
 Extension for 3D slicer that enables user to interact with the 3D scene using virtual reality.
 
@@ -9,6 +8,8 @@ The extension works with all OpenVR-compatible headsets, such as [HTC Vive](#set
 
 [![Demo: Pedicle screw insertion in virtual reality using Slicer](https://img.youtube.com/vi/F_UBoE4FaoY/0.jpg)](https://www.youtube.com/watch?v=F_UBoE4FaoY)
 
+## Features
+
 Features include:
 - View all content of any of the 3D viewers in Slicer, anytime, by a single click.
 - Show volumes as 2D image slices or volume rendering, render surfaces, points, etc.
@@ -22,9 +23,6 @@ Features include:
 
 Feature set of the extension is continuously improved. You can give us feedback and propose ideas for improvements by submitting them on the [issue tracker](https://github.com/KitwareMedical/SlicerVirtualReality/issues).
 
-Usage
------
-
 ## Setup
 
 **Platform support:** Currently the extension only works on Windows computers. Linux support is experimental: [Steam VR has limited support on linux](https://github.com/ValveSoftware/SteamVR-for-Linux/blob/master/README.md) and the Slicer extension is built for Linux but not tested. The extension is not available on macOS, as currently there are no virtual reality headsets available for macOS. If you wish to use Virtual Reality extension on Linux or macOS and you have virtual reality capable hardware and Steam VR works well on your computer then add a comment in the issue tracker ([macOS](https://github.com/KitwareMedical/SlicerVirtualReality/issues/3) / [Linux](https://github.com/KitwareMedical/SlicerVirtualReality/issues/57)).
@@ -72,10 +70,10 @@ Controls:
 - Touchpad forward: fly forward
 - Touchpad backwad: fly backward
 
-Notes:
-- Flying direction is specified by the orientation of the controller.
-- Speed is proportional to distance of the fingertip from the touchpad center.
-- Maximum speed is configurable in Virtual Reality module.
+> [!NOTE]
+> - Flying direction is specified by the orientation of the controller.
+> - Speed is proportional to distance of the fingertip from the touchpad center.
+> - Maximum speed is configurable in Virtual Reality module.
 
 ### Transform entire scene
 
@@ -86,9 +84,9 @@ Controls: while keeping grip button depressed on both controllers
 - Translate controllers in parallel up/down/left/right/forward/backward: translate the entire scene
 - Pivot controllers around: rotate the entire scene
 
-Notes:
-- Object positions in the scene are not modified.
-- Controllers must be outside of all selectable objects when grip buttons are pressed.
+> [!NOTE]
+> - Object positions in the scene are not modified.
+> - Controllers must be outside of all selectable objects when grip buttons are pressed.
 
 ### Transform objects
 
@@ -99,12 +97,12 @@ Controls: press grip button when a controller is inside a selectable object
 - Translate controllers in parallel up/down/left/right/forward/backward: translate all objects
 - Move controller
 
-Notes:
-- When you grab and move object, a parent transform is automatically created for it (if it has not been under a transform already) and that transform is modified.
-- To move a group of objects together, assign the same parent transform to them. You can do that in _Data_ module's _Transform hierarchy_ tab by drag-and-dropping objects under the same transform (or by double-clicking in the _Applied Transform_ column in  _Data_ module's _Transform hierarchy_ tab and selecting a transform; or by selecting a transform in _Transforms_ module and applying it to all the nodes that must move together).
-- Either left or right controller can be used to grab an object. Each controller can be used to grab an object and move independently.
-- By default all objects are selectable. An object can be made non-selectable (thus non-movable) in Data module / Subject hierarchy tab, right-clicking on the node and unchecking "Toggle Selectable".
-- Moving of segmentation nodes is slow. If you want to move segmentations using controllers then export them to model nodes (in _Data_ module, right-click on the segmentation node and choose _Export visible segments to models_) and transform the model nodes.
+> [!NOTE]
+> - When you grab and move object, a parent transform is automatically created for it (if it has not been under a transform already) and that transform is modified.
+> - To move a group of objects together, assign the same parent transform to them. You can do that in _Data_ module's _Transform hierarchy_ tab by drag-and-dropping objects under the same transform (or by double-clicking in the _Applied Transform_ column in  _Data_ module's _Transform hierarchy_ tab and selecting a transform; or by selecting a transform in _Transforms_ module and applying it to all the nodes that must move together).
+> - Either left or right controller can be used to grab an object. Each controller can be used to grab an object and move independently.
+> - By default all objects are selectable. An object can be made non-selectable (thus non-movable) in Data module / Subject hierarchy tab, right-clicking on the node and unchecking "Toggle Selectable".
+> - Moving of segmentation nodes is slow. If you want to move segmentations using controllers then export them to model nodes (in _Data_ module, right-click on the segmentation node and choose _Export visible segments to models_) and transform the model nodes.
 
 ## Other features
 
@@ -167,26 +165,22 @@ If you are certain that you have found a software bug and no similar issue has b
 
 Please do not use "VR" acronym (you can spell out "virtual reality" instead), because "VR" may mean "volume rendering" just as well as "virtual reality" - you can even do volume rendering in virtual reality in Slicer - and so it becomes confusing very quickly.
 
-For developers
---------------
+## For developers
 
 Information for developers is available in the [Developer Guide](DeveloperGuide.md).
 
-Contributors
-------------
+## Contributors
 
 Contributors include:
 - Kitware: Jean-Christophe Fillion-Robin, Jean-Baptiste Vimort
 - PerkLab (Queen's University): Csaba Pinter, Andras Lasso
 - VASST Lab (Robarts Research Insitute): Adam Rankin
 
-How to cite
------------
+## How to cite
 
 Pinter, C., Lasso, A., Choueib, S., Asselin, M., Fillion-Robin, J. C., Vimort, J. B., Martin, K., Jolley, M. A. & Fichtinger, G. (2020). SlicerVR for Medical Intervention Training and Planning in Immersive Virtual Reality. IEEE Transactions on Medical Robotics and Bionics, vol. 2, no. 2, pp. 108-117, May 2020, doi: 10.1109/TMRB.2020.2983199
 
-License
--------
+## License
 
 It is covered by the Apache License, Version 2.0: