File tree 2 files changed +34
-32
lines changed
2 files changed +34
-32
lines changed Original file line number Diff line number Diff line change @@ -30,10 +30,6 @@ of libraries designed to rapidly develop robot applications.
30
30
31
31
[ Usage] ( #usage )
32
32
33
- [ Documentation] ( #documentation )
34
-
35
- [ Testing] ( #testing )
36
-
37
33
[ Folder Structure] ( #folder-structure )
38
34
39
35
[ Code of Conduct] ( #code-of-conduct )
@@ -57,37 +53,11 @@ See the [installation tutorial](https://ignitionrobotics.org/api/rendering/4.0/i
57
53
# Usage
58
54
59
55
The Ign Rendering API can be found in the documentation. See the
60
- [ Documentation ] ( #documentation ) section on how to build the
61
- documentation files using Doxygen.
56
+ [ installation tutorial ] ( https://ignitionrobotics.org/api/rendering/4.0/installation.html )
57
+ on how to build the documentation files using Doxygen.
62
58
63
59
You can also take a look at the sample applications in the ` examples ` folder.
64
60
65
- # Documentation
66
-
67
- API documentation can be generated using Doxygen
68
-
69
- sudo apt install -y doxygen
70
-
71
- Build documentation
72
-
73
- cd build
74
- make doc
75
-
76
- View documentation
77
-
78
- firefox doxygen/html/index.html
79
-
80
- # Testing
81
-
82
- Tests can be run by building the ` test ` target:
83
-
84
- cd build
85
- make test
86
-
87
- To run tests specific to a render engine, set the ` RENDER_ENGINE_VALUES ` environment variable, e.g.
88
-
89
- RENDER_ENGINE_VALUES=ogre2 make test
90
-
91
61
# Folder Structure
92
62
93
63
* ` include/ignition/rendering ` : Contains all the public header files which will be installed
Original file line number Diff line number Diff line change @@ -195,3 +195,35 @@ This assumes you have created and activated a Conda environment while installing
195
195
```
196
196
cmake --install . --config Release
197
197
```
198
+
199
+ # Documentation
200
+
201
+ API documentation can be generated using Doxygen
202
+ ```
203
+ sudo apt install -y doxygen
204
+ ```
205
+
206
+ Build documentation
207
+ ```
208
+ cd build
209
+ make doc
210
+ ```
211
+
212
+ View documentation
213
+ ```
214
+ firefox doxygen/html/index.html
215
+ ```
216
+
217
+ # Testing
218
+
219
+ Tests can be run by building the ` test ` target:
220
+ ```
221
+ cd build
222
+ make test
223
+ ```
224
+
225
+ To run tests specific to a render engine, set the ` RENDER_ENGINE_VALUES ` environment variable, e.g.
226
+ ```
227
+ RENDER_ENGINE_VALUES=ogre2 make test
228
+ ```
229
+
You can’t perform that action at this time.
0 commit comments