summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSean V Kelley <seanvk@posteo.de>2017-01-21 21:40:11 -0800
committerSean V Kelley <seanvk@posteo.de>2017-01-21 21:40:11 -0800
commit1c745cf56f36a117fcb12a2611918f3e40b26f66 (patch)
treea4ea66523904b5c4405628079d1cfee437cd03be /README.md
parentf9be71b7424640eb25d31ca9735c9a42faa8871b (diff)
downloadlibva-1c745cf56f36a117fcb12a2611918f3e40b26f66.tar.gz
Update documentation for github
Adding and modifying typical files used on github for documentation. Signed-off-by: Sean V Kelley <seanvk@posteo.de>
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9c5100e..41fb60a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,23 @@
-# libva
-Libva is an implementation for VA-API (VIdeo Acceleration API)
+#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!
+
+The libva development team can be reached via our [mailing
+list](http://lists.freedesktop.org/mailman/listinfo/libva) and on IRC
+in channel #intel-media on [Freenode](https://freenode.net/kb/answer/chat).