From 60192aecfa8b1bb7b0f033a9be65b1dd9dffd0d5 Mon Sep 17 00:00:00 2001 From: qijungu Date: Sat, 31 Mar 2018 21:03:43 -0500 Subject: [PATCH] README --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d89998c..54441be 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,23 @@ Of course, if you want to share your screen on the Internet, all you need to do **Security reminder** Do not run this service if you do not need to share screen. -## Requirements (what I have in my own computer) +## Requirements -+ Fedora 26 + Gnome3 running on Xorg +This tool can run on Linux, Windows and MAC. -+ Python 2.7 ++ Python 2.x or 3.x -+ Know issue: This tool does not work with Wayland because of a security reason. You must use Xorg (by selecting Xorg on login). ++ Know issue: In Linux, this tool does not work with Wayland because of a security reason. You must use Xorg (by selecting Xorg on login). -## Installation and Run +## Install and Run 1. pip install Flask-Bootstrap pyscreenshot 2. In a directory, run "**git clone https://gitlab.com/qijungu/screenshare.git**". You will have a new directory "screenshare" with code inside. -3. The command to run is "**python screenshare.py [port]**". Default port is 18331. Example commands are below. +3. To start the screen sharing service, run "**python screenshare.py [port]**". + + The default service port is 18331. Example commands are below. \# host screenshots on port 18331 python screenshare.py