ccl/bots-of-conduct
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added instructions to run the bots and connect to the xmpp chatroom

Browse Source
This commit is contained in:
mb 2020-06-10 21:24:32 +02:00
parent 77f97b7ad2
commit 3cb72f2137
1 changed files with 20 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -133,16 +133,16 @@ For computers running **Linux OS**:
**slixmpp**: **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**: **code editor**:
* if you dont have a code editor, we can suggest (among others) [Sublime Text](https://www.sublimetext.com/) * if you dont have a code editor, we can suggest (among others) [Sublime Text](https://www.sublimetext.com/) or [Atom](https://atom.io/)
* to install the conversations app on your phone, you could use either Conversations or [Quicksy](https://quicksy.im/) for Android phones (among others)
## Run the bots! ## 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 * go to the folder where you have downloaded them
* run the following commands in the terminal: * run the following commands in the terminal:
`$ pip3 install slixmpp requests` `$ 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 <br> `-o` stands for for output <br>
`. ` means here `. ` 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: <https://blabber.im/anmelden/>
* But a longer list of servers can be found here: <https://list.jabber.at/>
* Use a XMPP client.
* We recommend using Converse.js (a web-client) for this workshop: <https://conversejs.org/fullscreen.html>
* But if you're curious, you can also install a desktop or mobile client. Some recommendations:
* Conversations (Android): <https://conversations.im/>
* Chatsecure (iOS): <https://chatsecure.org/>
* Gajim (Windows, Mac OS, Linux): <https://gajim.org/>
* Dino (Linux): <https://dino.im/>
* Join the following room: `botsofconduct@muc.vvvvvvaria.org`
## Footnotes ## 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!** **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!**