va.h: fix comments error for arbitrary number of MBs per slice.

[android-x86/hardware-intel-common-libva.git] / README.md

diff --git a/README.md b/README.md
index 9c5100e..f5527ae 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,38 @@
-# libva
-Libva is an implementation for VA-API (VIdeo Acceleration API)
+[![Stories in Ready](https://badge.waffle.io/01org/libva.png?label=ready&title=Ready)](http://waffle.io/01org/libva)
+[![Build Status](https://travis-ci.org/01org/libva.svg?branch=master)](https://travis-ci.org/01org/libva)
+[![Coverity Scan Build Status](https://scan.coverity.com/projects/11605/badge.svg)](https://scan.coverity.com/projects/01org-libva)
+
+# Libva Project
+
+Libva is an implementation for VA-API (Video Acceleration API)
+
+VA-API is an open-source library and API specification, which
+provides access to graphics hardware acceleration capabilities
+for video processing. It consists of a main library and
+driver-specific acceleration backends for each supported hardware 
+vendor.
+
+If you would like to contribute to libva, check our [Contributing
+guide](https://github.com/01org/libva/blob/master/CONTRIBUTING.md).
+
+We also recommend taking a look at the ['janitorial'
+bugs](https://github.com/01org/libva/issues?q=is%3Aopen+is%3Aissue+label%3AJanitorial)
+in our list of open issues as these bugs can be solved without an
+extensive knowledge of libva.
+
+We would love to help you start contributing!
+
+Doxygen files are regularly updated through Github Pages and can
+be accessed directly through [github pages
+libva](http://01org.github.io/libva/)
+
+The libva development team can be reached via our [mailing
+list](https://lists.01.org/mailman/listinfo/intel-vaapi-media) and on IRC
+in channel ##intel-media on [Freenode](https://freenode.net/kb/answer/chat).
+
+We also use [#Slack](https://slack.com) and host [VAAPI Media Slack
+Team](https://intel-media.slack.com).  You can signup by submitting your email 
+address to our [Slack Team invite page](https://slack-join-intel-media.herokuapp.com).
+
+Slack complements our other means of communication.  Pick the one that works
+best for you!