From 3cb72f213768536e3246ae390ba9e8ae8605d6e7 Mon Sep 17 00:00:00 2001 From: mb Date: Wed, 10 Jun 2020 21:24:32 +0200 Subject: [PATCH] added instructions to run the bots and connect to the xmpp chatroom --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ac0da80..0fdcb85 100644 --- a/README.md +++ b/README.md @@ -133,16 +133,16 @@ For computers running **Linux OS**: **slixmpp**: -This is the Python library we use to make the bots. You can install it by running: $ pip3 install slixmpp +This is the Python library we use to make the bots. You can install it by running: `$ pip3 install slixmpp` **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) +* if you dont have a code editor, we can suggest (among others) [Sublime Text](https://www.sublimetext.com/) or [Atom](https://atom.io/) ## Run the bots! -* download the bots from this page +First download the bots from this page. + * go to the folder where you have downloaded them * run the following commands in the terminal: `$ pip3 install slixmpp requests` @@ -155,6 +155,22 @@ This is the Python library we use to make the bots. You can install it by runnin `-o` stands for for output
`. ` means here +Join the chatroom! + +To join the chatroom, you need to use a XMPP client and an account. + +* Start by making a XMPP account. + * We recommend to register one on this server for the workshop: + * But a longer list of servers can be found here: +* Use a XMPP client. + * We recommend using Converse.js (a web-client) for this workshop: + * But if you're curious, you can also install a desktop or mobile client. Some recommendations: + * Conversations (Android): + * Chatsecure (iOS): + * Gajim (Windows, Mac OS, Linux): + * Dino (Linux): +* Join the following room: `botsofconduct@muc.vvvvvvaria.org` + ## Footnotes **Link to references [pad](https://pad.vvvvvvaria.org/Bots_of_Conduct_References) — further references and materials assembled by Joana and Cristina - feel free to add your own!**