docs and testing to install

Signed-off-by: John Shepherd <[email protected]>
gazebosim · Jan 20, 2021 · 1961cdd · 1961cdd
1 parent 5cc0d77
commit 1961cdd
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -30,10 +30,6 @@ of libraries designed to rapidly develop robot applications.
 
 [Usage](#usage)
 
-[Documentation](#documentation)
-
-[Testing](#testing)
-
 [Folder Structure](#folder-structure)
 
 [Code of Conduct](#code-of-conduct)
@@ -57,37 +53,11 @@ See the [installation tutorial](https://ignitionrobotics.org/api/rendering/4.0/i
 # Usage
 
 The Ign Rendering API can be found in the documentation. See the
-[Documentation](#documentation) section on how to build the
-documentation files using Doxygen.
+[installation tutorial](https://ignitionrobotics.org/api/rendering/4.0/installation.html)
+on how to build the documentation files using Doxygen.
 
 You can also take a look at the sample applications in the `examples` folder.
 
-# Documentation
-
-API documentation can be generated using Doxygen
-
-    sudo apt install -y doxygen
-
-Build documentation
-
-    cd build
-    make doc
-
-View documentation
-
-    firefox doxygen/html/index.html
-
-# Testing
-
-Tests can be run by building the `test` target:
-
-    cd build
-    make test
-
-To run tests specific to a render engine, set the `RENDER_ENGINE_VALUES` environment variable, e.g.
-
-    RENDER_ENGINE_VALUES=ogre2 make test
-
 # Folder Structure
 
 * `include/ignition/rendering`: Contains all the public header files which will be installed

diff --git a/tutorials/02_install.md b/tutorials/02_install.md
@@ -195,3 +195,35 @@ This assumes you have created and activated a Conda environment while installing
   ```
   cmake --install . --config Release
   ```
+
+# Documentation
+
+API documentation can be generated using Doxygen
+  ```
+  sudo apt install -y doxygen
+  ```
+
+Build documentation
+  ```
+  cd build
+  make doc
+  ```
+
+View documentation
+  ```
+  firefox doxygen/html/index.html
+  ```
+
+# Testing
+
+Tests can be run by building the `test` target:
+  ```
+  cd build
+  make test
+  ```
+
+To run tests specific to a render engine, set the `RENDER_ENGINE_VALUES` environment variable, e.g.
+  ```
+  RENDER_ENGINE_VALUES=ogre2 make test
+  ```
+