more doc

Author: th-skam

README.md

@@ -10,28 +10,35 @@ This is a SOFA plugin (https://github.com/sofa-framework/sofa) that provides a c
 
 ## Installation and Setup
 
-Official documentation on installing a SOFA plugin from source and setting up the external_directories folder:
+Official SOFA doc for building external plugins and setting up an `external_directories` folder: 
 https://sofa-framework.github.io/doc/plugins/build-a-plugin-from-sources/
 
-# Build Steps
+### Build Steps
+
 
 - Clone this repository into your SOFA external_directories folder:
     - git clone https://github.com/InfinyTech3D/CollisionAlgorithm.git
-- Register the path to the `CollisionAlgorithm` plugin repository in the CMakeLists.txt file of your external_directories folder 
+- Register the path to your local `CollisionAlgorithm` repository in the CMakeLists.txt file of your external_directories folder 
+`sofa_add_subdirectory(plugin CollisionAlgorithm CollisionAlgorithm)`
 - Set SOFA_EXTERNAL_DIRECTORIES variable (preferably using CMake GUI) to point to your external_directories folder
 - Configure and generate the SOFA solution using CMake
 - Compile SOFA solution (the plugin will be compiled as well)
 
+>![NOTE]
+> In order to use the plugin, make sure that you have also built the `ConstraintGeometry` plugin.
+
+Supported SOFA versions: > v25.06
+
 ## Architecture
 
 - doc:
-    - Documentation and screenshots of the exampples
+    - Documentation and screenshots of the examples
 - scenes:
     - Various simple demo scenes
 - src/CollisionAlgorithm:
     - source code of the insertion algorithm SOFA component and supporting collision pipeline classes
 - regression:
-    - Files for automated regression testing in alignement with SOFA's testing framework
+    - Files for automated regression testing in alignment with SOFA's testing framework
 
 ## Acknowledgments
 This project builds upon the original repository from [ICube Laboratory, University of Strasbourg](https://icube.unistra.fr/en/) and extends it with a needle insertion algorithm and additional functionality.