Skip to content

Commit d1497b6

Browse files
authored
Merge pull request #179 from bakpaul/25_04_add_header_for_auto_generated_plugin_lists
Add headers for auto generated plugin list
2 parents 53233fe + 142ea1d commit d1497b6

5 files changed

Lines changed: 41 additions & 0 deletions

File tree

10_Getting_Started/20_Build/10_Linux.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,13 +230,19 @@ git clone -b master https://github.com/sofa-framework/sofa.git sofa/src
230230
- choose the build type by setting CMAKE_BUILD_TYPE to "Release" or "RelWithDebInfo" (recommended) or "Debug"
231231
- activate or deactivate plugins: see PLUGIN_XXX variables
232232
- activate or deactivate functionalities: see SOFA_XXX variables
233+
234+
/// note | What is there to activate ?
235+
[Here](../activate-plugins/) is an exhaustive list of plugins that can be activated for an in-tree compilation.
236+
///
233237

234238
Do not forget to **Configure** again to check if your changes are valid.
235239

236240
9. When you are ready, run **Generate**.
237241

238242

239243

244+
245+
240246
## Compile
241247

242248
To compile, open a terminal in your build directory and run `make` or `ninja` depending on the generator you chose during CMake configuration.

10_Getting_Started/20_Build/20_MacOS.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,12 @@ git clone -b master https://github.com/sofa-framework/sofa.git sofa/src
195195
196196
Do not forget to **Configure** again to check if your changes are valid.
197197
198+
/// note | What is there to activate ?
199+
[Here](../activate-plugins/) is an exhaustive list of plugins that can be activated for an in-tree compilation.
200+
///
201+
202+
203+
198204
7. When you are ready, run **Generate**.
199205
200206

10_Getting_Started/20_Build/30_Windows.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,10 @@ git clone -b master https://github.com/sofa-framework/sofa.git sofa/src
156156

157157
Do not forget to **Configure** again to check if your changes are valid.
158158

159+
/// note | What is there to activate ?
160+
[Here](../activate-plugins/) is an exhaustive list of plugins that can be activated for an in-tree compilation.
161+
///
162+
159163
9. When you are ready, run **Generate**. In the build directory, this will create a Visual Studio project (.sln) or a Makefile depending on the generator you chose at step 4.
160164

161165

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Activable plugins for in-tree compilation
2+
3+
Multiple extensions can be activated when building the project. They fall into three categories:
4+
1. Applications: extensions that offer SOFA-based executable applications (e.g. a main for launching SOFA)
5+
2. Plugins: extensions that enriche the SOFA API by adding new components or providing more support for external libraries (e.g. new constitutive laws, alternative GUIs)
6+
3. Directories: extensions that contain multiple CMake projects that cannot be described by only one of the above type
7+
Moreover, these projects are either present in the SOFA sources or they need to be fetched (meaning that they have their own external repository).
8+
9+
This page aims at summarizing those extensions in tables containing:
10+
- the name + hyperlink to the extension sources either in the SOFA repository or in its own repository
11+
- a short description
12+
- activation directives
13+
14+
The activation directives propose two ways of activating those plugins in the build tree:
15+
1. Through custom CMake flags that [can be added during the CMake call](https://cmake.org/cmake/help/latest/manual/cmake.1.html#cmdoption-cmake-D). All of those plugins can be activated with one or two CMake flags named using their type and name. For example, the plugin SofaPython3 can be activated by activating both flags `SOFA_FETCH_SOFAPYTHON3=ON` and `PLUGIN_SOFAPYTHON3=ON` (because its sources are in a separate repository).
16+
2. Through preset that can be [specified during the CMake call](https://cmake.org/cmake/help/latest/manual/cmake-presets.7.html#introduction)
17+
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Officially supported plugins
2+
3+
This page aims at summarizing all plugins that are officially supported by the SOFA consortium.
4+
This means that the SOFA consortium commits to:
5+
1. Including them in our continuous integration pipeline, thus assessing the compilation at every push in the SOFA master branch, at each new pull-request and at each nightly build
6+
2. Including them in the official bi-annual SOFA binaries
7+
3. Providing technical support on these plugins
8+

0 commit comments

Comments
 (0)