external/miraclecast
1
0
Fork 0
mirror of https://github.com/albfan/miraclecast.git synced 2025-02-12 17:41:56 +00:00
Code Issues Releases Wiki Activity
miraclecast/README.md

76 lines
2.4 KiB
Markdown
Raw Normal View History

render README in markdown
2014-09-02 23:13:52 +00:00
# MiracleCast - Wifi-Display/Miracast Implementation
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
The MiracleCast project provides software to connect external monitors to your
system via Wifi. It is compatible to the Wifi-Display specification also known
as Miracast. MiracleCast implements the Display-Source as well as Display-Sink
side.
The Display-Source side allows you to connect external displays to your system
and stream local content to the device. A lot of effort is put into making this
as easy as connecting external displays via HDMI.
render README in markdown
2014-09-02 23:13:52 +00:00
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
On the other hand, the Display-Sink side allows you to create wifi-capable
external displays yourself. You can use it on your embedded devices or even on
full desktops to allow other systems to use your device as external display.
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
Website:
build: update fdo links We use "miracle" as project-name and for all links and tokens. The fancy name stays "MiracleCast". Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-15 13:10:25 +00:00
http://www.freedesktop.org/wiki/Software/miracle
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
## Requirements
The MiracleCast projects requires the following software to be installed:
- **systemd**: A system management daemon. It is used for device-management (udev),
dbus management (sd-bus) and service management.
Systemd must be compiled with --enable-kdbus, even though kdbus isn't used,
but only the independent, experimental sd-libraries.
*required*: >=systemd-213
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
- **glib**: A utility library. Used by the current DHCP implementation. Will be
removed once sd-dns gains DHCP-server capabilities.
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
*required*: ~=glib2-2.38 (might work with older releases, untested..)
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
- **check**: Test-suite for C programs. Used for optional tests of the MiracleCast
code base.
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
*optional*: ~=check-0.9.11 (might work with older releases, untested..)
add gstreamer prerequisites
2014-11-21 21:14:39 +00:00
- **gstreamer**: MiracleCast relay on gstreamer to show cast its output. You can test if
all needed is installed launching `res/test_viewer.sh`
render README in markdown
2014-09-02 23:13:52 +00:00
## Download
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
Released tarballs can be found at:
build: update fdo links We use "miracle" as project-name and for all links and tokens. The fancy name stays "MiracleCast". Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-15 13:10:25 +00:00
http://www.freedesktop.org/software/miracle/releases
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
## Install
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
To compile MiracleCast, run the standard autotools commands:
render README in markdown
2014-09-02 23:13:52 +00:00
```bash
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
$ test -f ./configure || NOCONFIGURE=1 ./autogen.sh
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
$ ./configure --prefix=/usr/local
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
$ make
$ sudo make install
To compile and run the test applications, use:
$ make check
render README in markdown
2014-09-02 23:13:52 +00:00
```
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
## Documentation
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
res: update README Add some proper information to the README file and point to the website for more details. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-11 14:43:09 +00:00
WIP - Please see the MiracleCast website
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
render README in markdown
2014-09-02 23:13:52 +00:00
## License
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
build: update README Update some old information in README. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-05-09 07:39:44 +00:00
This software is licensed under the terms of the GNU-LGPL license. Please see
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
./COPYING for further information.
render README in markdown
2014-09-02 23:13:52 +00:00
## Contact
Initial MiracleCast Implementation This initial commit contains the main "miracled" daemon that does link-management and peer-discovery/control. The "miraclectl" tool can be used to control this daemon during runtime. Note that this implementation is still missing a lot of stuff. All it currently does is provide link-management and basic peer-discovery. Following commits will hook everything else up. The actual Miracast/Wifi-Display related runtime control is not being worked on, yet. Feel free to use the proof-of-concept from the OpenWFD repository. The MiracleCast implementation will not get any such functionality unless the basic link-management is properly working. Signed-off-by: David Herrmann <dh.herrmann@gmail.com>
2014-02-06 15:43:11 +00:00
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.
render README in markdown
2014-09-02 23:13:52 +00:00
Reference in a new issue Copy permalink