Skip to content

Commit

Permalink
[Readme] Update content
Browse files Browse the repository at this point in the history
+ add credits section
+ add ongoing dev section
+ minor corrections
  • Loading branch information
jcarpent authored Sep 24, 2018
1 parent 07bb13b commit a545c92
Showing 1 changed file with 26 additions and 8 deletions.
34 changes: 26 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,13 @@ It is built upon Eigen for linear algebra and FCL for collision detections. **Pi

**Pinocchio** is now at the hearth of various robotics softwares as the [Stack-of-Tasks](http://stack-of-tasks.github.io) or the [Humanoid Path Planner](https://humanoid-path-planner.github.io/hpp-doc).

## Ongoing developments

If you want to follow the current developments, you can directly refer to the [devel branch](https://github.com/stack-of-tasks/pinocchio/tree/devel).

## Installation

**Pinocchio** can be easily installed on various Linux and Unix distributions. Please refer to the [installation procedure](http://stack-of-tasks.github.io/pinocchio/download.html).
**Pinocchio** can be easily installed on various Linux (Ubuntu, Fedora, etc.) and Unix distributions (Mac OS X, BSD, etc.). Please refer to the [installation procedure](http://stack-of-tasks.github.io/pinocchio/download.html).

## Examples

Expand Down Expand Up @@ -53,7 +57,7 @@ The content of the tutorials are described [here](http://projects.laas.fr/gepett

## Citing Pinocchio

To cite **Pinocchio** in your academic research, please use the following bibtex line:
To cite **Pinocchio** in your academic research, please use the following bibtex lines:
```
@misc{pinocchioweb,
author = {Justin Carpentier and Florian Valenza and Nicolas Mansard and others},
Expand All @@ -62,19 +66,33 @@ To cite **Pinocchio** in your academic research, please use the following bibtex
year = {2015--2018}
}
```

The algorithms for the analytical derivatives of rigid-body dynamics algorithms are detailed here:
```
@inproceedings{carpentier2018analytical,
title={Analytical Derivatives of Rigid Body Dynamics Algorithms},
author={Carpentier, Justin and Mansard, Nicolas},
booktitle={Robotics: Science and Systems},
year={2018}
title = {Analytical Derivatives of Rigid Body Dynamics Algorithms},
author = {Carpentier, Justin and Mansard, Nicolas},
booktitle = {Robotics: Science and Systems},
year = {2018}
}
```

## Questions
## Questions and Issues

You have a question or an issue? You may either directly open a [new issue](https://github.com/stack-of-tasks/pinocchio/issues) or use the mailing list <pinocchio@laas.fr>.

## Credits

The following people have been involved in the development of **Pinocchio**:

- [Justin Carpentier](https://jcarpent.github.io) (INRIA): main developer and manager of the project
- [Nicolas Mansard](http://projects.laas.fr/gepetto/index.php/Members/NicolasMansard) (LAAS-CNRS): project instructor
- [Guilhem Saurel](http://projects.laas.fr/gepetto/index.php/Members/GuilhemSaurel) (LAAS-CNRS): continuous integration and deployment
- [Joseph Mirabel](http://jmirabel.github.io/) (LAAS-CNRS): Lie groups support
- [Antonio El Khoury](https://www.linkedin.com/in/antonioelkhoury) (Wandercraft): bug fixes
- [Gabriele Buondono](http://projects.laas.fr/gepetto/index.php/Members/GabrieleBuondonno) (LAAS-CNRS): bug fixes

You need to ask a question? You may either directly post a [new issue](https://github.com/stack-of-tasks/pinocchio/issues) or use the mailing list <pinocchio@laas.fr>
If you have taken part to the development of **Pinocchio**, feel free to add your name and contribution here.

## Acknowledgments

Expand Down

0 comments on commit a545c92

Please sign in to comment.