Skip to content

Commit 1961cdd

Browse files
author
John Shepherd
committed
docs and testing to install
Signed-off-by: John Shepherd <[email protected]>
1 parent 5cc0d77 commit 1961cdd

File tree

2 files changed

+34
-32
lines changed

2 files changed

+34
-32
lines changed

README.md

+2-32
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@ of libraries designed to rapidly develop robot applications.
3030

3131
[Usage](#usage)
3232

33-
[Documentation](#documentation)
34-
35-
[Testing](#testing)
36-
3733
[Folder Structure](#folder-structure)
3834

3935
[Code of Conduct](#code-of-conduct)
@@ -57,37 +53,11 @@ See the [installation tutorial](https://ignitionrobotics.org/api/rendering/4.0/i
5753
# Usage
5854

5955
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.
6258

6359
You can also take a look at the sample applications in the `examples` folder.
6460

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-
9161
# Folder Structure
9262

9363
* `include/ignition/rendering`: Contains all the public header files which will be installed

tutorials/02_install.md

+32
Original file line numberDiff line numberDiff line change
@@ -195,3 +195,35 @@ This assumes you have created and activated a Conda environment while installing
195195
```
196196
cmake --install . --config Release
197197
```
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+

0 commit comments

Comments
 (0)