add a README with doc and description

Author: th-skam

README.md

@@ -1,6 +1,37 @@
+# Collision Algorithm for Needle Insertion - SOFA Plugin
+
+[![Support](https://img.shields.io/badge/support-on_GitHub_Discussions-blue.svg)](https://github.com/sofa-framework/sofa/discussions/)
+[![Discord](https://img.shields.io/badge/chat-on_Discord-darkred.svg)](https://discord.gg/G63t3a8Ra6)
+[![Contact](https://img.shields.io/badge/contact-on_website-orange.svg)](https://infinytech3d.com/)
+[![Support us](https://img.shields.io/badge/support_us-on_Github_Sponsor-purple.svg)](https://github.com/sponsors/InfinyTech3D)
+
 ## Description
-This is a SOFA plugin (https://github.com/sofa-framework/sofa) that provides a customized collision pipeline, specifically designed to support needle insertion simulations. 
-Works in conjunction with https://github.com/InfinyTech3D/ConstraintGeometry.
+This is a SOFA plugin (https://github.com/sofa-framework/sofa) that provides a customized collision pipeline, tailored for needle insertion simulations. 
+
+## Installation and Setup
+
+Official documentation on installing a SOFA plugin from source and setting up the external_directories folder:
+https://sofa-framework.github.io/doc/plugins/build-a-plugin-from-sources/
+
+# 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 
+- 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)
+
+## Architecture
+
+- doc:
+    - Documentation and screenshots of the exampples
+- 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
 
 ## 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.