Mentions légales du service

Skip to content
Snippets Groups Projects
Verified Commit 4f190700 authored by Mattéo Delabre's avatar Mattéo Delabre
Browse files

Rename to VNSee

parent 7916ad6b
No related branches found
No related tags found
No related merge requests found
cmake_minimum_required(VERSION 3.7)
project(rmvncclient)
project(vnsee)
# Import libvncserver in static mode
set(BUILD_SHARED_LIBS OFF CACHE STRING "" FORCE)
set(WITH_GNUTLS OFF CACHE STRING "" FORCE)
add_subdirectory(libvncserver)
# Options for building rmvncclient
# Options for building vnsee
option(CHECK_INCLUDES "Run include-what-you-use to check #includes" OFF)
option(CHECK_TIDY "Run clang-tidy linter" OFF)
option(TRACE "Print tracing messages on standard output" OFF)
......@@ -36,7 +36,7 @@ if(TRACE)
add_definitions(-DTRACE)
endif()
add_executable(rmvncclient
add_executable(vnsee
src/app/buttons.cpp
src/app/client.cpp
src/app/pen.cpp
......@@ -57,11 +57,11 @@ if(CMAKE_VERSION VERSION_LESS "3.8")
message(FATAL_ERROR "Unknown compiler")
endif()
else()
set_property(TARGET rmvncclient PROPERTY CXX_STANDARD 17)
set_property(TARGET vnsee PROPERTY CXX_STANDARD 17)
endif()
target_link_libraries(rmvncclient PRIVATE vncclient)
target_include_directories(rmvncclient PRIVATE
target_link_libraries(vnsee PRIVATE vncclient)
target_include_directories(vnsee PRIVATE
${CMAKE_CURRENT_BINARY_DIR}/libvncserver
libvncserver
)
# rmvncclient
# VNSee
[VNC](https://en.wikipedia.org/wiki/Virtual_Network_Computing) client for the [reMarkable tablet](https://remarkable.com) allowing you to turn the device into a second screen for your computer.
[VNC](https://en.wikipedia.org/wiki/Virtual_Network_Computing) client for the [reMarkable tablet](https://remarkable.com) allowing you to use the device as a second screen.\
(Previously called _rmvncclient_.)
<img alt="Illustration of a reMarkable table connected to a computer, showing half of a terminal window through its E-Ink screen" src="media/setup.gif" width="700">
......@@ -16,13 +17,13 @@ It relies on a well-established protocol supporting multiple platforms including
The reMarkable is a writer tablet featuring an E-Ink display, a Wacom pen digitizer and a touchscreen, that can be used for reading, sketching or note-taking.
It runs a fully open, Linux-based, system.
rmvncclient brings both worlds together by allowing the tablet to connect to a remote VNC server, show the remote screen on its E-Ink display and interact with it through the pen digitizer and touchscreen.
VNSee brings both worlds together by allowing the tablet to connect to a remote VNC server, show the remote screen on its E-Ink display and interact with it through the pen digitizer and touchscreen.
This can effectively turn the tablet into a second screen for your computer.
Applications include reading web-based content, typing documents, drawing, or previewing [LaTeX documents](https://www.latex-project.org/) as you compose them.
## Install on the reMarkable
Grab the latest build from the [releases page](https://github.com/matteodelabre/rmvncclient/releases) (or build the software yourself by following the [build guide](docs/build.md)), then copy the `rmvncclient` executable to the tablet by [using SSH](https://remarkablewiki.com/tech/ssh).
Grab the latest build from the [releases page](https://github.com/matteodelabre/vnsee/releases) (or build the software yourself by following the [build guide](docs/build.md)), then copy the `vnsee` executable to the tablet [using SSH](https://remarkablewiki.com/tech/ssh).
This VNC client is compatible with VNC servers that are capable of sending pixels in the RGB565 format and that use a resolution compatible with reMarkable’s screen size (1408 × 1872 pixels).
It has successfully been tested with [x11vnc](https://github.com/LibVNC/x11vnc).
......@@ -42,7 +43,7 @@ The details are specific to the operating system you’re using:
## Using the client
You can quit rmvncclient at any time using the “Power” button (the one above the screen).
You can quit VNSee at any time using the “Power” button (the one above the screen).
Activity on the touchscreen will be translated to mouse interactions following the mapping in the table below.
<table>
......
......@@ -22,8 +22,8 @@ sudo mv OEToolchainConfig.cmake /usr/local/oecore-x86_64/sysroots/x86_64-oesdk-l
Clone this repository with its dependencies and change directory into it.
```sh
git clone --recursive https://github.com/matteodelabre/rmvncclient
cd rmvncclient
git clone --recursive https://github.com/matteodelabre/vnsee
cd vnsee
```
Create a directory for build artifacts.
......@@ -44,7 +44,7 @@ The output should not contain any error and should end with those lines:
```txt
-- Configuring done
-- Generating done
-- Build files have been written to: …/rmvncclient/build/Release
-- Build files have been written to: …/vnsee/build/Release
```
Run build.
......@@ -53,4 +53,4 @@ Run build.
make
```
You now have a `rmvncclient` executable ready to be executed on your reMarkable!
You now have a `vnsee` executable ready to be executed on your reMarkable!
......@@ -93,12 +93,12 @@ Flag | Description
---- | -----------
`-rotate xy` | Use to flip the screen upside down
## Start rmvncclient
## Start VNSee
Finally, start rmvncclient using SSH.
Finally, start VNSee using SSH.
```sh
$ ssh root@10.11.99.1 "systemctl stop xochitl && ./rmvncclient; systemctl start xochitl"
$ ssh root@10.11.99.1 "systemctl stop xochitl && ./vnsee; systemctl start xochitl"
```
**Note:** If you get a message saying that the `Server uses an unsupported resolution`, you did not configure your screen correctly.
......
media/setup.gif

136 KiB | W: | H:

media/setup.gif

136 KiB | W: | H:

media/setup.gif
media/setup.gif
media/setup.gif
media/setup.gif
  • 2-up
  • Swipe
  • Onion skin
......@@ -157,11 +157,11 @@
] (sheet-title) at (
{.5 * (\windowwidth - \sheetwidth) + \monitorborder},
\sheetheight - \monitorborder
) {rmvncclient};
) {VNSee};
\node[textbox, below=0.1cm of sheet-title] (sheet-desc) {
VNC client for the reMarkable tablet allowing you to turn the
device into a second screen for your computer.
\node[textbox, below=0.1cm of sheet-title, align=flush left] (sheet-desc) {
VNC client for the reMarkable tablet allowing you to use the device as a second screen.
(Previously called \emph{rmvncclient}.)
};
}
......
......@@ -26,7 +26,7 @@ auto help(const char* name) -> void
{
std::cerr << "Usage: " << name << " [IP [PORT]] [OPTION...]\n"
"Connect to the VNC server at IP:PORT.\n\n"
"Only when launching rmvncclient from a SSH session is the IP optional,\n"
"Only when launching VNSee from a SSH session is the IP optional,\n"
"in which case the client’s IP address is taken by default.\n"
"By default, PORT is 5900.\n\n"
"Available options:\n"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment