From fcf15bed9e509c2dd308e40f2ca3666acfe1884b Mon Sep 17 00:00:00 2001 From: Ian Gulliver Date: Wed, 24 Feb 2021 23:19:40 +0000 Subject: [PATCH] Better install/use documentation --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 750fb26..0a92572 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,31 @@ Each presentation computer runs a [Python client](present/present.py) which inje Remote presenters send commands from a web browser. One or more administrators control which presenters can send commands at any time. SlideTogether is divided into "rooms". Rooms are entirely separate, with different presentation computers, presenters, and administrators. When you visit [slidetogether.io](https://slidetogether.io/), you are redirected into a new room. You can copy & paste the URL into meeting invites. The first person in the room is an administrator; all others default to optional presenters who have to be enabled by the administrator. + +## Installation + +Installation is *only required on the computer that will be sharing its screen*. Users who are pressing keys to control the presentation and administrators who are selecting who can control the presentation do so via web browsers. + +### MacOS Pre-Installation + +Do this first if you're running MacOS. + +* Install [homebrew](https://brew.sh/) +* ```brew install python3``` + +Then continue below. + +### All Platform Installation + +* ```sudo pip3 install --upgrade pip``` +* ```sudo pip3 install --upgrade requests sseclient-py pyautogui``` +* ```git clone https://github.com/firestuff/slidetogether.git``` + +## Use + +* Administrator: Go to [slidetogether.io](https://slidetogether.io/) to generate a new room +* Screen sharer: ```slidetogether/present/present.py 'FULL_ROOM_URL_HERE'``` +* Screen sharer: Share as normal with your normal video conferencing software. Ensure that left/right arrows move the presentation locally. +* Presentation controllers: Go to the room URL in a web browser and enter your name in the top box +* Administrator: Enable users when it is their turn to present +* Presentation controllers: Click the buttons or use left/right arrow to move the slides