1
0
Fork 0
mirror of https://github.com/kbumsik/VirtScreen.git synced 2025-02-12 19:31:50 +00:00
VirtScreen/README.md
2018-04-26 16:57:46 -04:00

35 lines
994 B
Markdown

# VirtScreen
> Make your iPad/tablet/computer as a secondary monitor on Linux.
![gif example](https://github.com/kbumsik/VirtScreen/blob/bcd216b0adcfbda3a8d807c1f2a7cfc5ca4864ba/icon/gif_example.gif?raw=true)
VirtScreen is an easy-to-use Linux GUI app that creates a virtual secondary screen and shares it through VNC.
VirtScreen is based on [PyQt5](https://www.riverbankcomputing.com/software/pyqt/intro) and [Twisted](https://twistedmatrix.com) in Python side and uses [x11vnc](https://github.com/LibVNC/x11vnc) and XRandR.
## Dependency
1. You need [`x11vnc`](https://github.com/LibVNC/x11vnc) and `xrandr`. To install (example on Ubuntu):
```bash
sudo apt-get install x11vnc xrandr
```
2. Install Python dependencies:
```
pip install -r requirements.txt
```
## How to run
Simply run this in the project root:
```bash
./virtscreen.py
or
python virtscreen.py
```
Note that any files related to VirtScreen, including password and log, will be stored in `~/.virtscreen` directory.