From ae3faa96466f3d8d03bb06ba53074a4eebf87d57 Mon Sep 17 00:00:00 2001 From: Vasile Popescu Date: Wed, 23 May 2018 23:30:57 +0200 Subject: [PATCH] Add a small section to README file about pre-built binaries --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index baf58ff..c285163 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,17 @@ Read more about how it works in the [documentation](doc/architecture.md). ![demo](doc/demo.gif) +Downloading and running the code +=============================== + +Download the latest `tty_sender` binary [release](https://github.com/elisescu/tty-share/releases), +and run it using a demo server instance at tty-share.elisescu.com: +``` +tty_sender --server tty-share.elisescu.com:7654 +``` +If you wanna keep using it, you can also create an alias and add it to your bash startup file +(.profile or .bashrc): `alias tty-share='tty_sender --server tty-share.elisescu.com:7654'` + Building and running the code ============================= @@ -25,14 +36,14 @@ cd - make all # builds both the sender and server ``` -### Run the server +### Run a development server ``` make runs ``` Will run the server on the localhost. -### Run the sender +### Run a development sender ``` make runc ```