Skip to content

Commit f738737

Browse files
authoredJul 12, 2018
Improve doxygen (#26)
* add overview on main doxygen landing * add doxygen groups to variables/constraints/costs * add parameter explanation
1 parent 59277d8 commit f738737

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+366
-39
lines changed
 

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# Contributing to <img src="https://i.imgur.com/zm2nwF7.png" width="15%"/>
2+
# Contributing to towr
33

44
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
55

‎README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,18 @@ We provide a [ROS]-wrapper for the pure cmake towr library, which adds a keyboar
9898
```bash
9999
roslaunch towr_ros towr_ros.launch
100100
```
101-
Click in the xterm terminal and hit 'o'.
101+
Click in the xterm terminal and hit 'o'.
102+
103+
[![Documentation](https://img.shields.io/badge/docs-generated-brightgreen.svg)](http://docs.ros.org/kinetic/api/towr/html/)
104+
For more detailed information on the parameters and how to tune them according to your problem, please see the
105+
doxygen [documentation](http://docs.ros.org/kinetic/api/towr/html/).
102106

103107
[<img src="https://i.imgur.com/LNuyEIn.gif" />](https://www.youtube.com/embed/7dP_QTPOyQ8?rel=0&autoplay=1)
104108

105109

106110
## Publications
107111
The theory behind this code can be found in this paper:
112+
108113
A. W. Winkler, D. Bellicoso, M. Hutter, J. Buchli, [Gait and Trajectory Optimization for Legged Systems through Phase-based End-Effector Parameterization](https://awinkler.github.io/publications), IEEE Robotics and Automation Letters (RA-L), 2018:
109114

110115
@article{winkler18,
@@ -124,13 +129,14 @@ A. W. Winkler, D. Bellicoso, M. Hutter, J. Buchli, [Gait and Trajectory Optimiza
124129
## Authors
125130
[Alexander W. Winkler](http://awinkler.me) - Initial Work/Maintainer
126131

132+
The work was carried out at the following institutions:
133+
127134
[<img src="https://i.imgur.com/aGOnNTZ.png" height="45" />](https://www.ethz.ch/en.html "ETH Zurich") &nbsp; &nbsp; &nbsp; &nbsp; [<img src="https://i.imgur.com/uCvLs2j.png" height="45" />](http://www.adrl.ethz.ch/doku.php "Agile and Dexterous Robotics Lab") &nbsp; &nbsp; &nbsp; &nbsp;[<img src="https://i.imgur.com/gYxWH9p.png" height="45" />](http://www.rsl.ethz.ch/ "Robotic Systems Lab")
128135

129136

130137

131138
## Contributing
132139
We love pull request, whether its new constraint formulations, additional robot models, bug fixes, unit tests or updating the documentation. Please have a look at [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
133-
134140
See here the list of [contributors](https://github.com/ethz-adrl/towr/graphs/contributors) who participated in this project.
135141

136142

@@ -159,4 +165,3 @@ To report bugs, request features or ask questions, please have a look at [CONTRI
159165
[catkin]: http://wiki.ros.org/catkin
160166
[catkin tools]: http://catkin-tools.readthedocs.org/
161167
[Eigen]: http://eigen.tuxfamily.org
162-
[Fa2png]: http://fa2png.io/r/font-awesome/link/

0 commit comments

Comments
 (0)