diff --git a/README.md b/README.md index 0bf30450..5c75dc38 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,8 @@ -

All development happens in the master branch. To get stable releases, use tags by going to the release section.

- -

Remote Access Library

+## [Getting Started](https://github.com/smasherprog/rat_lite/wiki) +### All development happens in the master branch. To get stable releases, use tags by going to the release section.

Linux/Mac

Windows

-

This library is intended to be a VNC-like application, but with a few design goals: -

- -## Required tools -* [Cmake](https://cmake.org/download/)(Latest!) -* [Nodejs](https://nodejs.org/en/download/current/)(Latest!) -* TypeScript/Electron/Angular install: `npm install -g typescript electron @angular/cli@latest` - -## Required Libraries -* Mac: brew install openssl zlib libjpeg-turbo -* Windows: vcpkg install openssl zlib libjpeg-turbo -* Ubutnu: sudo apt-get npm install libxext-dev libx11-dev libxfixes-dev libxinerama-dev libxtst-dev libjpeg-turbo8-dev libssl-dev zlib1g-dev -y - -

Building

-

Below are examples to build. Some paths, like windows vcpkg will need to be updated to your location to the vcpkg.cmake

- -
Windows Connecting to Mac