summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCormac Morris <cormacmorris@hotmail.com>2015-11-09 13:48:05 +0000
committerCormac Morris <cormacmorris@hotmail.com>2015-11-09 13:48:05 +0000
commit22d1aecb11f48838e8f61122b15da82ca6df7eb7 (patch)
treeb4fe637e4eedbd6c493e14ad8335bd34946cc074 /README.md
parentc66d1e5d1fdc48641743e953e0134a5318459a18 (diff)
Updated readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..808cf82
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+Files and their uses:
+
+updatebusinfo.py - This will scrape the delicious HTML (tables in particular) from all the specified buses and their respective pages.
+
+Usage: python updatebusinfo.py - this will then populate the folder this script is located with textfiles with the scraped date.
+
+cleanupbusinfo.sh - This uses sed to clean up the HTML so it's a nice usable format for the main IRC script.
+
+Usage: ./cleanupbusinfo.sh *.txt - will clean all text files in the folder (but you can also specify specific text files if you wish)
+
+ircbus.py - This is the script that goes through the cleaned up text files to find appropriate times for the bus stop requested by the user.
+
+Usage: !bus <stop> <number> <inbound/outbound> \ No newline at end of file