summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorDavid Herrmann <dh.herrmann@gmail.com>2014-02-04 16:13:23 +0100
committerDavid Herrmann <dh.herrmann@gmail.com>2014-02-04 16:29:40 +0100
commit6d57a6a0d910d78c1279a9463ca2bae7c6a6cdfb (patch)
treec52cf2c3e9b07ce2ee796ded3b759f2cc539fb0b /README
Import libwfd from OpenWFD
Initial import of most generic WFD stuff from OpenWFD. The libwfd library will be independent of any Miracast implementation so it can be shared across projects. It will not provide any fancy integration or policy, but only the most basic protocol parsers and handling. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
Diffstat (limited to 'README')
-rw-r--r--README40
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..4c184a2
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+= libwfd - Wifi-Display/Miracast Protocol Implementation =
+
+TODO
+
+Website:
+ http://www.freedesktop.org/wiki/Software/miraclecast
+
+== Requirements ==
+
+ libwfd has no runtime requirements other than a ISO-C compatible C library.
+
+== Download ==
+
+Released tarballs can be found at:
+ http://www.freedesktop.org/software/miraclecast/releases
+
+== Install ==
+
+ To compile libwfd, run the standard autotools commands:
+ $ test -f ./configure || NOCONFIGURE=1 ./autogen.sh
+ $ ./configure --prefix=/usr
+ $ make
+ $ sudo make install
+ To compile and run the test applications, use:
+ $ make check
+
+== Documentation ==
+
+WIP
+
+== License ==
+
+ This software is licensed under the terms of an MIT-like license. Please see
+ ./COPYING for further information.
+
+== Contact ==
+
+ This software is maintained by:
+ David Herrmann <dh.herrmann@gmail.com>
+ If you have any questions, do not hesitate to contact one of the maintainers.