From 3e91b126afe0224ad5977bf4e3ddbe0101d1a4d5 Mon Sep 17 00:00:00 2001 From: mb Date: Wed, 10 Jun 2020 20:57:25 +0200 Subject: [PATCH] updated the install instructions --- README.md | 44 ++++++++++++++++++++++++++++++++++---------- 1 file changed, 34 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 0e301a1..3d9aff6 100644 --- a/README.md +++ b/README.md @@ -135,23 +135,45 @@ We move to [an Etherpad](https://pad.vvvvvvaria.org/botsofconduct.workshop-Burg- #### _Installing and Running the Bots_ (optional) -**For computers running Windows OS** -* install [Anaconda](https://docs.anaconda.com/anaconda/install/windows/) with python 3 +During this workshop we will use: -**For computers running MacOS** -* open the terminal -* check which version of python you have: - > python -V -* if you have a python 2 version, you could install [Anaconda](https://docs.anaconda.com/anaconda/install/mac-os/) with python 3 +* python3 +* pip3 +* slixmpp +* a code editor + +Some installation guides can be found under the following links. + +**python3 + pip3**: + +*For computers running Windows OS or Mac OS*: + +1. check what version of Python you have on your computer with `$ python --version` +2. if you have python 2.x, try also the following, to be sure that you don't have python3 already: `$ python3 --version` +3. if this returns a "Could not be found" (or something like that), then proceed to install python3. If it returns a version number, then you have python3 already! +4. to install python3, you can download python under the following links and follow the installation instructions: + - https://www.python.org/ftp/python/3.8.3/python-3.8.3-macosx10.9.pkg (Mac OS 10.9 and later) + - https://www.python.org/ftp/python/3.8.3/python-3.8.3-amd64.exe (Windows) + +pip3 comes installed with python3. + +You can check if it installed correctly by running: `$ pip3 --version` + +*For computers running Linux OS* -**For computers running Linux OS** * open the terminal * check which version of python you have: > python -V > python3 -V * if you have a python 2 version, you could install python 3 - > sudo apt-get install python3 - > sudo apt-get install python3-pip + > sudo apt install python3 + > sudo apt install python3-pip + +**slixmpp**: + +This is the Python library we use to make the bots. You can install it by running: $ pip3 install slixmpp + +**run the bots!**: * download the bots from this page * go to the folder where you have installed them @@ -166,6 +188,8 @@ We move to [an Etherpad](https://pad.vvvvvvaria.org/botsofconduct.workshop-Burg- - o stands for for output - . means here +**code editor**: + * if you dont have a code editor, we can suggest (among others) [Sublime Text](https://www.sublimetext.com/) * to install the conversations app on your phone, you could use either Conversations or [Quicksy](https://quicksy.im/) for Android phones (among others)