mirror of
https://github.com/kbumsik/VirtScreen.git
synced 2025-03-09 15:40:18 +00:00
README: updated How to Use
This commit is contained in:
parent
c31f7054c4
commit
451ada820b
1 changed files with 6 additions and 12 deletions
18
README.md
18
README.md
|
@ -31,9 +31,10 @@ VirtScreen is based on [PyQt5](https://www.riverbankcomputing.com/software/pyqt/
|
||||||
|
|
||||||
## How to use
|
## How to use
|
||||||
|
|
||||||
### GUI (default)
|
1. Run the app.
|
||||||
|
2. Set options (resolution etc.) and enable the virtual screen.
|
||||||
Upon installation (see Installing section to install), there will be a desktop entry called `VirtScreen`
|
3. Go to VNC tab and then start the VNC server.
|
||||||
|
4. Run your favorite VNC client app on your second device and connect it to the IP address appeared on the app.
|
||||||
|
|
||||||
### CLI-only option
|
### CLI-only option
|
||||||
|
|
||||||
|
@ -94,7 +95,7 @@ Download a `.deb` package from [releases page](https://github.com/kbumsik/VirtSc
|
||||||
```shell
|
```shell
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install x11vnc
|
sudo apt-get install x11vnc
|
||||||
sudo dpkg -i virtscreen_0.2.4-1_all.deb
|
sudo dpkg -i virtscreen_0.2.4-1_all.deb
|
||||||
rm virtscreen_0.2.4-1_all.deb
|
rm virtscreen_0.2.4-1_all.deb
|
||||||
```
|
```
|
||||||
|
|
||||||
|
@ -108,14 +109,7 @@ yaourt virtscreen
|
||||||
|
|
||||||
### Python `pip`
|
### Python `pip`
|
||||||
|
|
||||||
Although not recommended, you may install it using `pip`. In this case, you need to install the dependancies manually.
|
Although not recommended, you may install it using `pip`. In this case, you need to install the dependancy (`xrandr` and `x11vnc`) manually.
|
||||||
|
|
||||||
You need [`x11vnc`](https://github.com/LibVNC/x11vnc), `xrandr`. To install (e.g. on Ubuntu):
|
|
||||||
```bash
|
|
||||||
sudo apt-get install x11vnc # On Debian/Ubuntu, xrandr is included.
|
|
||||||
```
|
|
||||||
|
|
||||||
After you install the dependancies then run:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo pip install virtscreen
|
sudo pip install virtscreen
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue