Bläddra i källkod

More instructions and details

deadtom 4 veckor sedan
förälder
incheckning
f2bd740fc8
1 ändrade filer med 26 tillägg och 4 borttagningar
  1. 26 4
      README.md

+ 26 - 4
README.md

@@ -5,16 +5,36 @@ A Python script that uses lists of names to create a suggested chat names list o
 I have it pre-populated with lists of characters from Looney Tunes, Lego City Undercover, and Futurma, but you can set up whatever list you want.
 
 
+### Making it talk to Owncast
+
+Near the top of the script, you'll see these three variables:
+
+    ```
+    owncast_url = "https://"  # The URL of your owncast instance
+    admin_name = "admin"  # Admin by default, change it accordingly
+    admin_passwd = ""  # Your Owncast admin passwd
+    ```
+
+Edit accordingly.
+
 
 ### Choosing a list
 
 You'll find the following entry near the bottom of the script:
 
     ```
-    list_name = list_you_want_to_use
+    list_name = futurama
     ```
 
-Be sure to change list_name = list_you_want_to_use to the name of the list you'd like to use. Do not enclose the name in quotes.
+As it sits, it is configured to use the list of futurama names. Change ```futurama``` to the name of the list you'd like to use.
+* Must match the list name exactly
+* Do **not** enclose it in quotes.
+
+There are three pre-populated lists.
+* looneytunes contains a list of characters from the old (relaly old now) "Looney Tunes" cartoons.
+* lego_city_undercover contains a list of characters from the game "Lego City Undercover".
+* futurama contains a list of characters from the show "Futurama".
+
 
 ### Creating your own list
 
@@ -22,15 +42,17 @@ If you're not familiar with python lists, they're pretty straight forward. Just
 
     ```my_name = ["Bob", "Joe", "Sue"]
     ```
-Make sure each of the names are enclosed in double quotes, with a comma and then a space between names. The last name in the list does not require a trailing comma or space.
+The part before the = sign is the name of the list. It cannot contain any spaces or punctuation
 
-Enclose the whole (after the = sign) list in standard brackets.
+The part after the = sign is the actual list. Make sure each of the names are enclosed in double quotes, with a comma and then a space between names. The last name in the list does not require a trailing comma or space. Enclose the whole list of names in standard brackets, as demonstrated in the above example.
 
 You can find a more detailed tutorial [here](https://www.w3schools.com/python/python_lists.asp).
 
+
 ### Running the script
 
 From the command line, enter the folder containing chatnames.py, and run the following command:
 
     ```python3 chatnames.py
     ```
+The output of the script will tell you if it was successful or not.