From efed6d54d0d96d6891ef8aacbceed77a3eaf83ce Mon Sep 17 00:00:00 2001 From: Akeem King Date: Fri, 4 May 2018 19:30:34 -0400 Subject: [PATCH 1/2] Adding installation script and instructions --- README.md | 6 ++++++ install.sh | 11 +++++++++++ 2 files changed, 17 insertions(+) create mode 100755 install.sh diff --git a/README.md b/README.md index 41f338e1..1f7a9a59 100755 --- a/README.md +++ b/README.md @@ -102,6 +102,12 @@ Before you run the torBot make sure the following things are done properly: * Make sure that your torrc is configured to SOCKS_PORT localhost:9050 +On Linux platforms, you can make an executable for TorBot by using the install.sh script. +You will need to give the script the correct permissions using `chmod +x install.sh` +Now you should have an executable file named torBot, run `./torBot` to execute the program. + +An alternative way of running torBot is shown below, along with help instructions. + `python3 torBot.py or use the -h/--help argument`
 `usage: torBot.py [-h] [-v] [--update] [-q] [-u URL] [-s] [-m] [-e EXTENSION]
diff --git a/install.sh b/install.sh
new file mode 100755
index 00000000..238dc53c
--- /dev/null
+++ b/install.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+mkdir -p tmp_build 
+mkdir -p tmp_dist
+
+pyinstaller --onefile --workpath ./tmp_build --distpath ./tmp_dist torBot.py
+
+mv tmp_dist/torBot . 
+
+rm -r tmp_build tmp_dist
+rm torBot.spec

From c638cd07ffb9171c396b8d52a539585709714ac1 Mon Sep 17 00:00:00 2001
From: Akeem King 
Date: Fri, 4 May 2018 19:34:15 -0400
Subject: [PATCH 2/2] Added some comments

---
 install.sh | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/install.sh b/install.sh
index 238dc53c..bd7cbd67 100755
--- a/install.sh
+++ b/install.sh
@@ -1,11 +1,15 @@
 #!/bin/bash
 
+# Makes directory for dependencies and executable to be installed
 mkdir -p tmp_build 
 mkdir -p tmp_dist
 
+# Creates executable file and sends dependences to the recently created directories
 pyinstaller --onefile --workpath ./tmp_build --distpath ./tmp_dist torBot.py
 
+# Puts the executable in the current directory
 mv tmp_dist/torBot . 
 
+# Removes both directories and unneeded file
 rm -r tmp_build tmp_dist
 rm torBot.spec