Skip to content

Commit

Permalink
docs: Add 'Quick Start' instructions in INSTALL.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nil0x42 committed Apr 10, 2019
1 parent 4acf722 commit e0b818d
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions INSTALL.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,26 @@
## Platform
## Quick Start

```sh
git clone https://github.com/nil0x42/phpsploit
cd phpsploit/
pip3 install -r requirements.txt
./phpsploit -ie 'help help'
```


### Platform

Compatible with GNU/Linux (and maybe Mac OS/X)
> _Tested on debian, kali, archlinux, and fedora_

## Python Version
### Python Version

Compatible with python >= 3.4
> _(Mostly tested with python 3.5)_

## Dependencies _(included in ./deps from now)_
### Dependencies _(included in ./deps from now)_

* **phpserialize**
`import phpserialize`
Expand All @@ -29,7 +39,7 @@ Compatible with python >= 3.4
Needed by the PROXY setting to support socks4/5 proxy types


## Optional dependencies
### Optional dependencies

* **pygments**
`import pygments`
Expand Down

0 comments on commit e0b818d

Please sign in to comment.