diff --git a/README.md b/README.md index 00d4e7ee..9db8b452 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..bd7cbd67 --- /dev/null +++ b/install.sh @@ -0,0 +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