Skip to content

Commit 562d0d1

Browse files
committed
[doc] Move Usage to the end of README
1 parent 259a75d commit 562d0d1

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,39 @@ plugin by InfinyTech3D for an enhanced simulation experience. Contact us for mor
2323
- Support for haptic feedback such as resistance during puncture and friction during insertion
2424
- Compatible with SOFA-Unity integration for real-time interactive applications
2525

26+
## Installation and Setup
27+
28+
First review the official SOFA documentation for building and registering SOFA plugins
29+
https://sofa-framework.github.io/doc/plugins/build-a-plugin-from-sources/
30+
31+
### Build Steps
32+
33+
- Set up your `external_directories` directory (described in the SOFA documentation link above)
34+
- Clone this repository into your `external_directories` directory:
35+
- git clone https://github.com/InfinyTech3D/CollisionAlgorithm.git
36+
- Register the path to your local `CollisionAlgorithm` repository in the CMakeLists.txt file located inside your `external_directories` directory
37+
```sofa_add_subdirectory(plugin CollisionAlgorithm CollisionAlgorithm)```
38+
- Set `SOFA_EXTERNAL_DIRECTORIES` variable (preferably using CMake GUI) to point to your `external_directories` directory
39+
- Configure and generate the SOFA solution using CMake
40+
- Compile SOFA solution (the plugin will be compiled as well)
41+
42+
> [!IMPORTANT]
43+
> In order to use the plugin, make sure that you have also built the downstream
44+
[`ConstraintGeometry`](https://github.com/InfinyTech3D/ConstraintGeometry) plugin.
45+
46+
Supported SOFA version: v25.06 and above
47+
48+
## Architecture
49+
50+
- doc:
51+
- Documentation and screenshots of the examples
52+
- scenes:
53+
- Various simple demo scenes
54+
- src/CollisionAlgorithm:
55+
- source code of the insertion algorithm SOFA component and supporting collision pipeline classes
56+
- regression:
57+
- Files for automated regression testing in alignment with SOFA's testing framework
58+
2659
## Usage
2760

2861
- To use the plugin, include the `CollisionAlgorithm` plugin in your SOFA .xml scene file.
@@ -76,39 +109,6 @@ Refer to the `scenes/NeedleInsertion.xml` example scene for guidance.
76109
</Node>
77110
```
78111

79-
## Installation and Setup
80-
81-
First review the official SOFA documentation for building and registering SOFA plugins
82-
https://sofa-framework.github.io/doc/plugins/build-a-plugin-from-sources/
83-
84-
### Build Steps
85-
86-
- Set up your `external_directories` directory (described in the SOFA documentation link above)
87-
- Clone this repository into your `external_directories` directory:
88-
- git clone https://github.com/InfinyTech3D/CollisionAlgorithm.git
89-
- Register the path to your local `CollisionAlgorithm` repository in the CMakeLists.txt file located inside your `external_directories` directory
90-
```sofa_add_subdirectory(plugin CollisionAlgorithm CollisionAlgorithm)```
91-
- Set `SOFA_EXTERNAL_DIRECTORIES` variable (preferably using CMake GUI) to point to your `external_directories` directory
92-
- Configure and generate the SOFA solution using CMake
93-
- Compile SOFA solution (the plugin will be compiled as well)
94-
95-
> [!IMPORTANT]
96-
> In order to use the plugin, make sure that you have also built the downstream
97-
[`ConstraintGeometry`](https://github.com/InfinyTech3D/ConstraintGeometry) plugin.
98-
99-
Supported SOFA version: v25.06 and above
100-
101-
## Architecture
102-
103-
- doc:
104-
- Documentation and screenshots of the examples
105-
- scenes:
106-
- Various simple demo scenes
107-
- src/CollisionAlgorithm:
108-
- source code of the insertion algorithm SOFA component and supporting collision pipeline classes
109-
- regression:
110-
- Files for automated regression testing in alignment with SOFA's testing framework
111-
112112
## Acknowledgments
113113
This project builds upon the original repository from
114114
[ICube Laboratory, University of Strasbourg](https://icube.unistra.fr/en/)

0 commit comments

Comments
 (0)