diff --git a/Readme.md b/Readme.md index 11105c0..c300120 100644 --- a/Readme.md +++ b/Readme.md @@ -1,3 +1,81 @@ -AVNC -==== -**AVNC** is a VNC client for Android. \ No newline at end of file + +

AVNC Banner + + +

AVNC is a VNC client for Android.

+ +------------------------------------------------------------------------------- + + +### Features +- Material Design (with Dark theme) +- Configurable gestures +- Tight encoding +- Virtual Keys +- Picture-in-Picture mode +- View-only mode +- Zeroconf Server Discovery +- TLS support (AnonTLS, VeNCrypt) +- SSH tunnel (VNC over SSH) +- Import/Export servers +- VNC Repeater support +- Clipboard Sync with server + + +### Screenshots + +[](metadata/en-US/images/phoneScreenshots/1.jpg) +[](metadata/en-US/images/phoneScreenshots/2.jpg) +[](metadata/en-US/images/phoneScreenshots/3.jpg) +[](metadata/en-US/images/phoneScreenshots/4.jpg) +[](metadata/en-US/images/phoneScreenshots/5.jpg) +[](metadata/en-US/images/phoneScreenshots/6.jpg) +[](metadata/en-US/images/phoneScreenshots/7.jpg) +[](metadata/en-US/images/phoneScreenshots/8.jpg) + + +Development +=========== + +Tools required: + +- Git +- Android Studio +- Android SDK +- NDK (with CMake) + +To get started, simply clone the repo and initialize submodules: + +```bash +git clone git@github.com:gujjwal00/avnc.git +cd avnc +git submodule update --init --depth 1 +``` + +Now you can import the project in Android Studio, or build it directly from terminal. + +Read [Architecture.kt](app/src/main/java/com/gaurav/avnc/Architecture.kt) (preferably in +Android Studio) to know more about the code. + + +------------------------------------------------------------------------------- + +To reduce build time during development, Libjpeg-turbo and LibreSSL are **not** +included in default build types. + +Thus, the Tight encoding, and security types based on TLS, will not work in such builds. +If you need these features, you can create a full build. + +Before creating a full build, you have to prepare the LibreSSL source tree: + +1. Make sure following packages are installed: automake, autoconf, git, libtool, perl +2. Run the following commands from root of the project: + ```bash + cd extern/libressl/ + ./autogen.sh + ``` + +Now, select an appropriate build type (`releaseAll`/`debugAll`) to create full build. +See [build.gradle](app/build.gradle) for available build types. + +------------------------------------------------------------------------------- diff --git a/metadata/en-US/branding/icon.svg b/metadata/en-US/branding/icon.svg new file mode 100644 index 0000000..cda076f --- /dev/null +++ b/metadata/en-US/branding/icon.svg @@ -0,0 +1,55 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/metadata/en-US/branding/wordmark.svg b/metadata/en-US/branding/wordmark.svg new file mode 100644 index 0000000..2a64595 --- /dev/null +++ b/metadata/en-US/branding/wordmark.svg @@ -0,0 +1,74 @@ + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/metadata/en-US/full_description.txt b/metadata/en-US/full_description.txt new file mode 100644 index 0000000..f0ed67c --- /dev/null +++ b/metadata/en-US/full_description.txt @@ -0,0 +1,16 @@ +AVNC is an open source VNC client for Android. It allows you to remotely control any device running a VNC server. + +Features: + +- Material Design (with Dark theme) +- Configurable gestures +- Tight encoding +- Virtual Keys +- Picture-in-Picture mode +- View-only mode +- Zeroconf Server Discovery +- TLS support (AnonTLS, VeNCrypt) +- SSH tunnel (VNC over SSH) +- Import/Export servers +- VNC Repeater support +- Clipboard Sync with server diff --git a/metadata/en-US/images/phoneScreenshots/1.jpg b/metadata/en-US/images/phoneScreenshots/1.jpg new file mode 100644 index 0000000..e222114 Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/1.jpg differ diff --git a/metadata/en-US/images/phoneScreenshots/2.jpg b/metadata/en-US/images/phoneScreenshots/2.jpg new file mode 100644 index 0000000..8021ade Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/2.jpg differ diff --git a/metadata/en-US/images/phoneScreenshots/3.jpg b/metadata/en-US/images/phoneScreenshots/3.jpg new file mode 100644 index 0000000..b994f1c Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/3.jpg differ diff --git a/metadata/en-US/images/phoneScreenshots/4.jpg b/metadata/en-US/images/phoneScreenshots/4.jpg new file mode 100644 index 0000000..2c4ef18 Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/4.jpg differ diff --git a/metadata/en-US/images/phoneScreenshots/5.jpg b/metadata/en-US/images/phoneScreenshots/5.jpg new file mode 100644 index 0000000..1d33823 Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/5.jpg differ diff --git a/metadata/en-US/images/phoneScreenshots/6.jpg b/metadata/en-US/images/phoneScreenshots/6.jpg new file mode 100644 index 0000000..2c69ffe Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/6.jpg differ diff --git a/metadata/en-US/images/phoneScreenshots/7.jpg b/metadata/en-US/images/phoneScreenshots/7.jpg new file mode 100644 index 0000000..a0e1bcc Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/7.jpg differ diff --git a/metadata/en-US/images/phoneScreenshots/8.jpg b/metadata/en-US/images/phoneScreenshots/8.jpg new file mode 100644 index 0000000..82378bb Binary files /dev/null and b/metadata/en-US/images/phoneScreenshots/8.jpg differ diff --git a/metadata/en-US/short_description.txt b/metadata/en-US/short_description.txt new file mode 100644 index 0000000..04443bf --- /dev/null +++ b/metadata/en-US/short_description.txt @@ -0,0 +1 @@ +Fast & Secure VNC client for Android diff --git a/metadata/en-US/title.txt b/metadata/en-US/title.txt new file mode 100644 index 0000000..8c07c4e --- /dev/null +++ b/metadata/en-US/title.txt @@ -0,0 +1 @@ +AVNC