Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
[ci skip]
  • Loading branch information
@drdanz
drdanz committed Apr 18, 2018
1 parent 0b34034 commit 0920217
Showing 1 changed file with 80 additions and 24 deletions.
104 changes: 80 additions & 24 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
![YARP logo](doc/images/yarp-robot-24.png?raw=true "YARP")
YARP
====

[![YARP homepage](https://img.shields.io/badge/YARP-Yet_Another_Robot_Platform-19c2d8.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAYAAADEtGw7AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4QEDEQMztwAfSwAAAhRJREFUOMvVlD9ME2EYxn931x4crVDbajTRwbQSg8ZuDm6NuombBgcTZxMXY4gLySV2YDFMupKwAtESRhIxEQdcIFEjqK1/SsBaWkr/3ZXenUPTUpprA7Ed/Lbvfb7n+d7vyfN+AgCvV89gSMt0YknGFcKhhEiXlsOuOHbuhDvkVurYk29bua/FsgEQ7JOl8cCpYzVsNV+qPI3/yTdr2HYc9rrkSHROGZ2eUbTkhuJzSvVzPqckaskNZXR6RolE55Sw1yUfumOA+M4uWV0nq+nAQW5W04llsgz09LS0QiQyMcnS4nzHzF1anCcyMenAwotg+Zvxl7dvsmeaDPl9TK0nD2C3BgMEvR6cop2Tlh8Lr60Vwys/M7IoVDeJBFnDsGrY+1xp7/JKYqu2L3/PHz4VBcO0Cob9S00TMub+Ra09toghimsd81gU17CICa0m78WF0/1XB/rkdhrvssXyg8+bu3aT1zJuwV7ZEXL3OtsJJ/WKeaTJA4hu57QvWrnSTvhTQa8cWfj5r3Txn6zu7idkaCVwvUEQ+huCrmGRassWOA6CqyGM6aoWCPXawsdHYD1uYL3l+sU7bYUXPjwD7u73wkNuXJrtqhX/n3DVY1UVOTn4ClG6Vkcqxiap9SFUtWzLVFUZX2AZp3y+Xitrs6Tj91FVs5oKh/ss27+Hm6gBRM8IMGX/Vs8IO6lQU/UeDvcY8OMv7HG7CnjlFeQAAAAASUVORK5CYII=)](http://www.yarp.it/)

__ __ ___ ____ ____
\ \/ // || _ \ | _ \
\ // /| || |/ / | |/ /
Expand All @@ -6,38 +12,46 @@
========================
Yet Another Robot Platform


YARP
====

[![YARP Homepage](https://img.shields.io/badge/YARP-Yet_Another_Robot_Platform-orange.svg)](http://www.yarp.it/)
[![Latest Release](https://img.shields.io/github/release/robotology/yarp.svg?label=Latest%20Release)](https://github.com/robotology/yarp/releases)
<a href="https://zenhub.com"><img src="https://raw.githubusercontent.com/ZenHubIO/support/master/zenhub-badge.png"></a>
[![Latest release](https://img.shields.io/github/release/robotology/yarp.svg)](https://github.com/robotology/yarp/releases)
[![Release date](https://img.shields.io/github/release-date/robotology/yarp.svg)](https://github.com/robotology/yarp/releases)

YARP is a library and toolkit for communication and device interfaces,
used on everything from humanoids to embedded devices.


Documentation
-------------

[![YARP documentation (master)](https://img.shields.io/badge/[master]_Documentation-yarp.it-19c2d8.svg)](http://www.yarp.it/)
[![YARP documentation (devel)](https://img.shields.io/badge/[devel]_Documentation-yarp.it-19c2d8.svg)](http://www.yarp.it/devel/)


Installation
------------

See full instructions at http://www.yarp.it/install.html

On macOS:
* On Linux:

```bash
sudo apt-get install cmake libace-dev
git clone https://github.com/robotology/yarp
cd yarp && mkdir build && cd build && cmake .. && make
sudo make install # Optional
```

brew install robotology/formulae/yarp
* On Windows:

On Linux:
Binaries at https://github.com/robotology/yarp/releases

sudo apt-get install cmake libace-dev
git clone https://github.com/robotology/yarp
cd yarp && mkdir build && cd build && cmake .. && make
sudo make install # Optional
* On macOS:

On Windows:
* Binaries at https://github.com/robotology/yarp/releases
```bash
brew install robotology/formulae/yarp
```

Regular YARP builds use the ACE library. On Linux and macOS,
YARP can be compiled without ACE by adding "-DSKIP_ACE=TRUE"
Regular YARP builds use the [ACE](https://github.com/DOCGroup/ACE_TAO) library.
On Linux and macOS, YARP can be compiled without ACE by adding `-DSKIP_ACE=TRUE`
when running cmake.


Expand All @@ -48,9 +62,12 @@ There's a comprehensive list of tutorials here:

* http://www.yarp.it/tutorials.html


License
-------

[![License](https://img.shields.io/badge/license-LGPL%20%2B%20others-19c2d8.svg)](https://github.com/robotology/yarp/blob/devel/LICENSE)

Material included in YARP is Copyright of Istituto Italiano di Tecnologia (IIT)
and RobotCub Consortium. YARP is released under the terms of the LGPL v2.1 or
later. See the file COPYING for details.
Expand All @@ -60,13 +77,52 @@ requirements than the LGPL:
+ libYARP_math uses the GNU Scientific Library, under the GPL.
+ devices urbtc, vfw, dimax_u2c have components that are under the GPL.

Status
------

[![Build Status (Linux/macOS)](https://travis-ci.org/robotology/yarp.svg?branch=master)](https://travis-ci.org/robotology/yarp)
[![Build status (Windows)](https://ci.appveyor.com/api/projects/status/github/robotology/yarp?branch=master&svg=true)](https://ci.appveyor.com/project/robotology/yarp)
CI Status
---------

[![Build Status (Linux/macOS) (master branch)](https://img.shields.io/travis/robotology/yarp/master.svg?logo=travis&label=[master]%20build%20(Linux/macOS))](https://travis-ci.org/robotology/yarp)
[![Build Status (Linux/macOS) (devel branch)](https://img.shields.io/travis/robotology/yarp/devel.svg?logo=travis&label=[devel]%20build%20(Linux/macOS))](https://travis-ci.org/robotology/yarp)

[![Build status (Windows) (master branch)](https://img.shields.io/appveyor/ci/robotology/yarp/master.svg?logo=appveyor&label=[master]%20build%20(Windows))](https://ci.appveyor.com/project/robotology/yarp)
[![Build status (Windows) (devel branch)](https://img.shields.io/appveyor/ci/robotology/yarp/devel.svg?logo=appveyor&label=[devel]%20build%20(Windows))](https://ci.appveyor.com/project/robotology/yarp)

and [more](http://dashboard.icub.org/index.php?project=YARP)

[![Coverage Status](https://img.shields.io/coveralls/robotology/yarp.svg?label=Coverage)](https://coveralls.io/r/robotology/yarp)

[![Issues](https://img.shields.io/github/issues/robotology/yarp.svg?label=Issues)](https://github.com/robotology/yarp/issues)
Stats
-----

[![Github commits (since latest release)](https://img.shields.io/github/commits-since/robotology/yarp/latest.svg)](https://github.com/robotology/yarp)
[![GitHub last commit (master branch)](https://img.shields.io/github/last-commit/robotology/yarp/master.svg?label=[master]%20last%20commit)](https://github.com/robotology/yarp)
[![GitHub last commit (devel branch)](https://img.shields.io/github/last-commit/robotology/yarp/devel.svg?label=[devel]%20last%20commit)](https://github.com/robotology/yarp)

[![GitHub commit activity the past week, 4 weeks, year](https://img.shields.io/github/commit-activity/y/robotology/yarp.svg)](https://github.com/robotology/yarp)
[![GitHub contributors](https://img.shields.io/github/contributors/robotology/yarp.svg)](https://github.com/robotology/yarp/graphs/contributors)

[![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/robotology/yarp.svg)](https://github.com/robotology/yarp/issues)
[![GitHub issues](https://img.shields.io/github/issues-raw/robotology/yarp.svg)](https://github.com/robotology/yarp/issues)

[![GitHub pull requests](https://img.shields.io/github/issues-pr-raw/robotology/yarp.svg)](https://github.com/robotology/yarp/pulls)
[![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/robotology/yarp.svg)](https://github.com/robotology/yarp/pulls)

[![GitHub top language](https://img.shields.io/github/languages/count/robotology/yarp.svg)](https://github.com/robotology/yarp)
[![GitHub language count](https://img.shields.io/github/languages/top/robotology/yarp.svg)](https://github.com/robotology/yarp)


Development Powered by
----------------------

[![GitHub](https://img.shields.io/badge/Hosted_on-GitHub-24292e.svg?logo=github)](https://github.com)

[![Travis](https://img.shields.io/badge/CI_(Linux/macOS)_by-Travis-blue.svg?logo=travis)](https://travis-ci.org)

[![AppVeyor](https://img.shields.io/badge/CI_(Windows)_by-AppVeyor-322525.svg?logo=appveyor)](https://ci.appveyor.com)

[![Slack](https://img.shields.io/badge/-Slack-4d394b.svg?logo=slack)](https://icub-facility.slack.com)

[![ZenHub](https://img.shields.io/badge/Shipping_faster_with-ZenHub-435198.svg)](https://zenhub.com)

[![Shields.io](https://img.shields.io/badge/Badges_by-Shields.io-green.svg)](https://shields.io/)

[![YARPino](https://img.shields.io/badge/YARP-ino-19c2d8.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABYAAAAWCAYAAADEtGw7AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAB3RJTUUH4QEDEQMztwAfSwAAAhRJREFUOMvVlD9ME2EYxn931x4crVDbajTRwbQSg8ZuDm6NuombBgcTZxMXY4gLySV2YDFMupKwAtESRhIxEQdcIFEjqK1/SsBaWkr/3ZXenUPTUpprA7Ed/Lbvfb7n+d7vyfN+AgCvV89gSMt0YknGFcKhhEiXlsOuOHbuhDvkVurYk29bua/FsgEQ7JOl8cCpYzVsNV+qPI3/yTdr2HYc9rrkSHROGZ2eUbTkhuJzSvVzPqckaskNZXR6RolE55Sw1yUfumOA+M4uWV0nq+nAQW5W04llsgz09LS0QiQyMcnS4nzHzF1anCcyMenAwotg+Zvxl7dvsmeaDPl9TK0nD2C3BgMEvR6cop2Tlh8Lr60Vwys/M7IoVDeJBFnDsGrY+1xp7/JKYqu2L3/PHz4VBcO0Cob9S00TMub+Ra09toghimsd81gU17CICa0m78WF0/1XB/rkdhrvssXyg8+bu3aT1zJuwV7ZEXL3OtsJJ/WKeaTJA4hu57QvWrnSTvhTQa8cWfj5r3Txn6zu7idkaCVwvUEQ+huCrmGRassWOA6CqyGM6aoWCPXawsdHYD1uYL3l+sU7bYUXPjwD7u73wkNuXJrtqhX/n3DVY1UVOTn4ClG6Vkcqxiap9SFUtWzLVFUZX2AZp3y+Xitrs6Tj91FVs5oKh/ss27+Hm6gBRM8IMGX/Vs8IO6lQU/UeDvcY8OMv7HG7CnjlFeQAAAAASUVORK5CYII=)](doc/images/yarp-robot-256.png?raw=true)

0 comments on commit 0920217

Please sign in to comment.