From da813d131689325a36d03042e145916d4402f67a Mon Sep 17 00:00:00 2001 From: Samuel Dowling Date: Sat, 25 Apr 2020 14:54:54 +0930 Subject: [PATCH] Formatting revision to improve clarity of instructions and added requirements.txt --- README.md | 8 ++++---- requirements.txt | 3 +++ 2 files changed, 7 insertions(+), 4 deletions(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index 67513ea..e512da9 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ $ python3 -m pip install --user pipx $ python3 -m pipx ensurepath ``` -Note that if you want to elevate privileges to run a `pipx` installation with `sudo`, you have two options: +Note that if you want to elevate privileges to run a program installed with `pipx`, with `sudo`, you have two options: 1. Append the appropriate path to your execution command, using _one_ of the following examples (recommended): @@ -83,7 +83,7 @@ Update the `secure_path` directive as follows: Defaults secure_path="/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/home/kali/.local/bin" ``` -Further detail is available in their installation instructions available [here](https://pipxproject.github.io/pipx/installation/). Please refer to this for any installation issues you experience. +If you're not using Kali Linux, make sure to adjust the path to the relevant user. Further detail on the installation of `pipx` is available in their installation instructions available [here](https://pipxproject.github.io/pipx/installation/). Please refer to this for any issues you experience. ### Supporting packages @@ -147,10 +147,10 @@ If you'd prefer not to use `pip` or `pipx`, you can always still install and exe $ pip install -r requirements.txt ``` -You will then be able to run the `autorecon.py` script: +You will then be able to run the `autorecon.py` script (from `/src/autorecon`): ```bash -$ python3 src/autorecon/autorecon.py [OPTIONS] 127.0.0.1 +$ python3 autorecon.py [OPTIONS] 127.0.0.1 ``` See detailed usage options below. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..d5cbce5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +colorama +toml +appdirs