1
0
Fork 0
mirror of https://github.com/kbumsik/VirtScreen.git synced 2025-02-12 11:21:53 +00:00

Updated AUR install in README

This commit is contained in:
Bumsik Kim 2018-05-21 04:54:18 -04:00
parent 277392e91e
commit 78b33e9133
No known key found for this signature in database
GPG key ID: E31041C8EC5B01C6
3 changed files with 33 additions and 22 deletions

View file

@ -8,42 +8,53 @@ VirtScreen is an easy-to-use Linux GUI app that creates a virtual secondary scre
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.
## Installation & running
## How to use
### Installing dependancies
Upon installation (see Installing section to install), there will be a desktop entry called `virtscreen`
![desktop entry](doc/desktop_entry.png)
Or you can run it using a command line:
```bash
$ virtscreen
```
Note that any files related to VirtScreen, including password and log, will be stored in `~/.virtscreen` directory.
## Dependancies
You need [`x11vnc`](https://github.com/LibVNC/x11vnc) and `xrandr`. To install (example on Ubuntu):
```bash
$ sudo apt-get install x11vnc
```
### Installing package
## Installing
#### Using `pip`
### Debian (Ubuntu)
A PPA package will be available soon.
### Arch Linux (AUR)
There is [`virtscreen` AUR package](https://aur.archlinux.org/packages/virtscreen/) available. Though there are many ways to install the AUR package, one of the easiest way is to use [`aurman`](https://github.com/polygamma/aurman) AUR helper:
```bash
$ aurman -S virtscreen
```
### Python `pip`
If your distro is none of above, you may install it using `pip`:
```bash
$ pip install virtscreen
```
#### From the Git repository directly
but a desktop entry won't be created.
### From the Git repository directly
```bash
$ python setup.py install # add --user option if you have permission problem
```
### How to run
Simply run `virtscreen` after installation:
```bash
$ virtscreen
```
If you want to run it directly from the Git repository:
```bash
$ ./launch.sh
```
Note that any files related to VirtScreen, including password and log, will be stored in `~/.virtscreen` directory.

BIN
doc/desktop_entry.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

View file

Before

Width:  |  Height:  |  Size: 7.8 MiB

After

Width:  |  Height:  |  Size: 7.8 MiB