diff --git a/README.md b/README.md index 6e28245..71e9433 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,31 @@ would like, however that shouldn't be necessary. The default method is to automatically select the best available. `pwncat` even gives you a nice progress bar while it uploads! +## Installation + +To install pwncat into its own python virtual environment: + +``` shell +# get pwncat +git clone https://github.com/calebstewart/pwncat/ +cd pwncat + +# install dependencies +sudo apt-get install python3-devel +python3 -m venv .venv +.venv/bin/pip install -r requirements.txt +.venv/bin/python3 setup.py install + +# usage +# activate the virtual environment +. .venv/bin/activate +# pwn +pwncat +# whence you finish pwning, exit the virtual environment +deactivate +``` + + ## More to come! I wrote this in the last few days, and there's bound to be bugs or edge-cases. diff --git a/requirements.txt b/requirements.txt index 45345b9..ab209b9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,5 @@ colorama==0.4.3 prompt-toolkit==3.0.5 -wcwidth==0.1.9 \ No newline at end of file +wcwidth==0.1.9 +netifaces==0.10.9 +pygments==2.6.1