Skip to content

Commit

Permalink
README: restructure to re-use common parts
Browse files Browse the repository at this point in the history
  • Loading branch information
bk138 authored Nov 20, 2024
1 parent 69117bb commit 3bdd805
Showing 1 changed file with 28 additions and 31 deletions.
59 changes: 28 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,46 +15,28 @@ Windows. There also is an [Android version](/android/).
The roadmap for future developments regarding the project can be found
[here](https://github.com/bk138/multivnc/projects).

## MultiVNC for Android

### Features
## Features

* Support for most VNC encodings including Tight.
* TLS support, i.e. AnonTLS and VeNCrypt.
* Support for SSH-Tunnelling with password- and privkey-based authentication.
* UltraVNC Repeater support.
* Discovery of VNC servers advertising themselves via ZeroConf.
* Bookmarking of connections.
* Supports server framebuffer resize.
* Experimental support for MulticastVNC.

### Android-only Features

* Support for SSH-Tunnelling with password- and privkey-based authentication.
* UltraVNC Repeater support.
* Import and export of saved connections.
* Virtual mouse button controls with haptic feedback.
* Two-finger swipe gesture recognition.
* A super fast touchpad mode for local use.
* Hardware-accelerated OpenGL drawing and zooming.
* Supports server framebuffer resize.
* Copy&paste to and from Android.

### How to get it

[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/com.coboltforge.dontmind.multivnc/)
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png"
alt="Get it on Google Play"
height="80">](https://play.google.com/store/apps/details?id=com.coboltforge.dontmind.multivnc)

### How to build

See the [Android version's README](android/README.md).

## MultiVNC for Desktop

### Features
### Desktop-only Features

* Support for most encodings including Tight.
* TLS support, i.e. AnonTLS and VeNCrypt.
* Discovery of VNC servers advertising themselves via ZeroConf.
* Bookmarking of connections.
* Supports server framebuffer resize.
* Several connections with one viewer using tabs.
* Listen mode (Reverse VNC). Via tabs it's possible to listen
for and serve multiple incoming connections.
Expand All @@ -63,18 +45,33 @@ See the [Android version's README](android/README.md).
(default upper) screen edge. Borrows heavily from x2vnc by
Fredrik Hübinette <hubbe@hubbe.net>, which in turn was based on
ideas from x2x and code from vncviewer.
* Simple, loggable statistics.
* MulticastVNC ;-)
* Simple, loggable statistics.

## How to get it

### MultiVNC for Android
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
alt="Get it on F-Droid"
height="80">](https://f-droid.org/packages/com.coboltforge.dontmind.multivnc/)
[<img src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png"
alt="Get it on Google Play"
height="80">](https://play.google.com/store/apps/details?id=com.coboltforge.dontmind.multivnc)

### How to get it
### MultiVNC for Desktop

[<img src="https://flathub.org/assets/badges/flathub-badge-i-en.png" width="190px" />](https://flathub.org/apps/details/net.christianbeier.MultiVNC)

To get bleeding-edge packages built from the master development branch, navigate to
[the list of CI runs](https://github.com/bk138/multivnc/actions/workflows/ci.yml),
select the last successful one and download the wanted artifact.

### How to build
## How to build

### MultiVNC for Android

See the [Android version's README](android/README.md).

### MultiVNC for Desktop

The prerequisites:

Expand Down

0 comments on commit 3bdd805

Please sign in to comment.