Skip to content

Commit b83a1ae

Browse files
authored
doc: Added note about Doxygen documentation in getting started
1 parent ac4cd20 commit b83a1ae

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/1.GettingStarted/GettingStarted.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Independent of the deployment environment, a choice may also be made regarding t
2020
## Choice of Hardware
2121
This choice is likely related to the application. CORC is designed for any robotic device which uses CANOpen components, however, due to the resources and researchers of the initial developers, the examples and templates are based on assistive and rehabilitative robotic devices from Fourier Intelligence. As such, if the user has access to such devices, it would be logical to take an example which uses this hardware.
2222

23+
## Code Documentation
24+
As you walk through the examples below, you may want to generate the code documentation. CORC code is documented using [Doxygen](https://www.doxygen.nl/). You can generate the documentation by running `doxygen Doxyfile` in the root folder. This will generate an HTML documentation in the `doc/html` folder: simply open doc/html/index.html in your browser.
25+
2326
# First Example: Basic Simulation - Exoskeleton
2427
With this in mind, CORC by default contains a number of example programs, which a new user can choose from to get hands-on with the toolbox for their first application. However, we first recommend you run the Basic Simulation- Exoskeleton example program to gain familiarity with the CORC Environment.
2528

@@ -80,7 +83,7 @@ See also the code example in `src/apps/M2DemoMachine`.
8083

8184

8285
## Hardware Testing - ArmMotus M3 (aka EMU) 3D Manipulandum
83-
This example enables simple functionalities of ArmMotus M3/EMU System. It shows basic interfaces of the robot, use of the kinematic modela, simple examples of position, velocity and impedance controls.
86+
This example enables simple functionalities of ArmMotus M3/EMU System. It shows basic interfaces of the robot, use of the kinematic models, simple examples of position, velocity and impedance controls.
8487

8588
### Requirements
8689
1. Development machine running Windows or Linux

0 commit comments

Comments
 (0)