diff --git a/README.md b/README.md index d0c615a..ac0da80 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ Currently, we use: Let's look into the bots [examples](https://git.vvvvvvaria.org/ccl/bots-of-conduct): +
+ ### Transit **_name:_** transit.py @@ -50,6 +52,8 @@ Let's look into the bots [examples](https://git.vvvvvvaria.org/ccl/bots-of-condu **_situation:_** finding non-verbal ways of communicating through presence and absence, making presence felt otherwise +
+ ### Gather **_name:_** gather.py @@ -58,6 +62,8 @@ Let's look into the bots [examples](https://git.vvvvvvaria.org/ccl/bots-of-condu **_situation:_** a collective discursive setting that generates its own vocabulary +
+ ### Greet **_name:_** greet.py @@ -66,6 +72,8 @@ Let's look into the bots [examples](https://git.vvvvvvaria.org/ccl/bots-of-condu **_situation:_** when there is a theme, for example: "send a reference to an existing or imaginary code of conduct, complaint, guideline, bug report, open letter, license or other social-technical protocol and explain why it is of interest to you."; how one wants to be introduced +
+ ### Spark **_name:_** spark.py @@ -74,6 +82,8 @@ Let's look into the bots [examples](https://git.vvvvvvaria.org/ccl/bots-of-condu **_situation:_** potentially in moments when a situation seems difficult and there is a need for more joyful interactions +
+ ### Whisper **_name:_** whisper.py @@ -82,6 +92,8 @@ Let's look into the bots [examples](https://git.vvvvvvaria.org/ccl/bots-of-condu **_situation:_** there are remarks or complaints in the room, but the person does not feel comfortable to bring up the issue themselves +
+ ## Installing and Running the Bots During this workshop we will use: @@ -112,12 +124,12 @@ You can check if it installed correctly by running: `$ pip3 --version` 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 install python3 - > sudo apt install python3-pip +* check which version of python you have:
+ `$ python --version`
+ `$ python3 --version`
+* if you have a python 2 version, you could install python 3
+ `$ sudo apt install python3`
+ `$ sudo apt install python3-pip` **slixmpp**: @@ -136,12 +148,12 @@ This is the Python library we use to make the bots. You can install it by runnin `$ pip3 install slixmpp requests` * to run a bot, you can copy paste the commands which are already mentioned in the bot file, but a general command looks like this: `$ python3 bot.py -d -j administratorbot@conversejs.org -r botsofconduct@muc.vvvvvvaria.org -n bot -p testing` -* where: - `-j` stands for JID (jabber id) \ - `-r` means room \ - `-n` stands for bot nickname \ - `-o` stands for for output \ - `. ` means here \ +* where:
+ `-j` stands for JID (jabber id)
+ `-r` means room
+ `-n` stands for bot nickname
+ `-o` stands for for output
+ `. ` means here ## Footnotes