1
0
Fork 0
mirror of https://github.com/albfan/miraclecast.git synced 2025-02-12 16:11:54 +00:00

better first step guide

This commit is contained in:
albfan 2015-03-05 23:58:10 +01:00
parent 028bfc3e34
commit bbb21f96cf

View file

@ -1,49 +1,32 @@
# MiracleCast - Wifi-Display/Miracast Implementation
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 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.
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.
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.
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.
Website:
http://www.freedesktop.org/wiki/Software/miracle
## 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.
- **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
- **glib**: A utility library. Used by the current DHCP implementation. Will be
removed once sd-dns gains DHCP-server capabilities.
- **glib**: A utility library. Used by the current DHCP implementation. Will be removed once sd-dns gains DHCP-server capabilities.
*required*: ~=glib2-2.38 (might work with older releases, untested..)
- **check**: Test-suite for C programs. Used for optional tests of the MiracleCast
code base.
- **check**: Test-suite for C programs. Used for optional tests of the MiracleCast code base.
*optional*: ~=check-0.9.11 (might work with older releases, untested..)
- **gstreamer**: MiracleCast relay on gstreamer to show cast its output. You can test if
all needed is installed launching `res/test_viewer.sh`
- **gstreamer**: MiracleCast relay on gstreamer to show cast its output. You can test if all needed is installed launching `res/test_viewer.sh`
- copy the dbus policy **res/org.freedesktop.miracle.conf** to `/etc/dbus-1/system.d/`
## Download
Released tarballs can be found at:
http://www.freedesktop.org/software/miracle/releases
Released tarballs can be found at: http://www.freedesktop.org/software/miracle/releases
## Install
@ -54,7 +37,7 @@ all needed is installed launching `res/test_viewer.sh`
$ ./configure --prefix=/usr/local
$ make
$ sudo make install
To compile and run the test applications, use:
To compile and run the test applications, use:
$ make check
```
@ -64,13 +47,19 @@ Steps to use it as sink:
1. shutdown wpa_supplicant
$ sudo kill -9 $(ps -ef | grep wpa_supplicant | awk "{print $1}")
$ sudo kill -9 $(ps -ef | grep wpa_supplican[t] | awk '{print $2}')
# now you can use `res/kill-wpa.sh`
2. start wpa with config for miraclecast
$ sudo wpa_supplicant -dd -B -iwlp3s0 -Dnl80211 -c wpa.conf
# or `res/miracle-wifi.sh`
2. launch wifi daemon
$ sudo miracle-wifid &
3. launch sink control
3. launch sink control (your network card will be detected. here 3)
$ sudo miracle-sinkctl
[ADD] Link: 3
@ -79,9 +68,9 @@ Steps to use it as sink:
> run 3
5. Discover your machine with other miracast device (mirroring)
5. Pair your machine with other miracast device (mirroring)
6. See your device on this machine
6. See your screen device on this machine
Steps to use it as peer:
@ -97,16 +86,23 @@ Steps to use it as peer:
> psp-scan
5. Apart from list, or show info with peer <mac> there's nothing useful here by now.
5. Apart from list, or show info with peer &lt;mac&gt; there's nothing useful here by now.
## License
This software is licensed under the terms of the GNU-LGPL license. Please see
./COPYING for further information.
This software is licensed under the terms of the GNU-LGPL license. Please see ./COPYING for further information.
## Contact
## Credits
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.
This software is originally maintained by: David Herrmann dh.herrmann@gmail.com
This fork is maintained by: Alberto Fanjul albertofanjul@gmail.com
If you have any questions, do not hesitate to contact one of the maintainers.
## Additional urls
- Website: http://www.freedesktop.org/wiki/Software/miracle
- Original repo: git://people.freedesktop.org/~dvdhrm/miracle
- Fork repo: https://github.com/albfan/miraclecast