diff --git a/README.md b/README.md index 9747024..5e3fd98 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,31 @@ # VirtScreen -Make your iPad/tablet/computer as a secondary monitor on Linux. +> Make your iPad/tablet/computer as a secondary monitor on Linux. + +VirtScreen is an easy-to-use Linux GUI app that creates a virtual secondary screen and shares it through VNC. + +VirScreen 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 +``` diff --git a/virtscreen.py b/virtscreen.py index 490e45d..f44c698 100755 --- a/virtscreen.py +++ b/virtscreen.py @@ -445,4 +445,4 @@ if __name__ == '__main__': window = Window() window.show() sys.exit(app.exec_()) - reactor.run() \ No newline at end of file + reactor.run()