Skip to content

Commit c0dd092

Browse files
navindakbenjamin-tam
authored andcommitted
Updated readme with citation info
- Added citation info - Added banner to config readme - Added shields - Minor edits
1 parent d975699 commit c0dd092

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
[![Syropod Banner](https://i.imgur.com/QyMTwG3.jpg "CSIRO Robotics")](https://research.csiro.au/robotics/)
44

5-
Syropod High-level controller for CSIRO multi-legged robots (Syropods) is a versatile high-level controller capable of generating gaits for quasi-static multilegged robots.
5+
[![Version](https://img.shields.io/badge/Current%20version-0.5.11-orange "Version")]() [![License](
6+
https://img.shields.io/badge/License-BSD%2FMIT-blue "License")](https://github.com/csiro-robotics/syropod_highlevel_controller/blob/feature/update_readme/LICENSE)
67

7-
Current version: v0.5.11
8+
Syropod High-level Controller (SHC) is a versatile controller capable of generating body poses and gaits for quasi-static multilegged robots.
89

910
<p align="center">
1011
<a href="https://research.csiro.au/robotics/our-work/research-areas/legged-robots/"><img alt="Gizmo Wizmo Zero" align="center" width="500" src="https://i.imgur.com/HCrmRDS.gif"/></a>
@@ -43,7 +44,22 @@ catkin build
4344

4445
### Publications
4546

46-
If you use this work in an academic context, please cite the following publication(s):
47+
The details of OpenSHC is published in the following article:
48+
49+
*Benjamin Tam, Fletcher Talbot, Ryan Steindl, Alberto Elfes, and Navinda Kottege, "OpenSHC: A Versatile Multilegged Robot Controller", [arXiv:2006.04424](https://arxiv.org/abs/2006.04424) [cs.RO], June 2020*
50+
51+
#### How to cite
52+
53+
```bibtex
54+
@article{tam2020openshc,
55+
title={OpenSHC: A Versatile Multilegged Robot Controller},
56+
author={Benjamin Tam and Fletcher Talbot and Ryan Steindl and Alberto Elfes and Navinda Kottege},
57+
year={2020},
58+
eprint={2006.04424},
59+
archivePrefix={arXiv},
60+
primaryClass={cs.RO}
61+
}
62+
```
4763

4864
## Features
4965

config/readme.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Syropod Parameter File
2+
3+
[![Syropod Banner](https://i.imgur.com/QyMTwG3.jpg "CSIRO Robotics")](https://research.csiro.au/robotics/)
4+
25
*config/\*SYROPOD_NAME\*.yaml*
36

47
## Control Parameters:

0 commit comments

Comments
 (0)