Skip to content

Commit 9c10410

Browse files
Update README.md
1 parent f8f351a commit 9c10410

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,62 @@ free exploit framework written use python language version 3.3
1414

1515
# Getting Started
1616
the framework not need many steps to install and start using just follow the next steps
17+
1718
## Platform
19+
1820
the framework designed to run on Gnu/Linux distro only
1921
> tell us if framework work in another platforms :)
22+
2023
## Prerequisites
2124
the requirement is:
2225
* bs4
2326
* python-tools
2427
* python3.x
2528
### Installing Requirement
2629
#### installing bs4
30+
2731
easily you can install the whole requirement from requirement.txt file by execute this command:
2832
```
2933
sudo python3-pip install -r requirements.txt
3034
```
3135
#### installing python-tools
36+
3237
in debian and her children the package names is python-examples and you can install it by the packages manager (apt) by ordered this command:
3338
```
3439
sudo apt-get install python-examples
3540
```
3641
but in opensuse is called python-demo and in fedora/redhat is called python-tools > in both of them you can also use the packages manager to install the package
42+
3743
#### installing python3
3844
the most of linux distro has python preinstalled but if you have old version you can install it using your packages manager or from the official website https://www.python.org/downloads/
45+
46+
## Install on you computer
47+
in 1.1 version we added installer to insatll the framework on your device so to start installing the tool go to tool directory and execute this command:
48+
```
49+
sudo python3 PySploit.py -i
50+
```
51+
if the install done the tool will tell you.
52+
now if you need unistall the tool you can execute this another command:
53+
```
54+
sudo python3 PySploit -un
55+
```
56+
> Note: you should execute the both command with root privilege
57+
3958
# Add your module
4059
we designed this framework to be easy to create your module all what you need is define three dictionarys and two functions :)
4160
you can read simple_sample.py file in samples directory for more informations
42-
> we work to add wiki page which explain how to create module from zero
61+
> to more info visit this topic https://github.com/ahmadnourallah/pysploit-framework/wiki/Add-your-module
62+
4363
# Authors
4464
### Ahmad Nourallah
4565
#### Contact with me
4666
* Facebook Account: <fb.com/ahmadnurallah>
4767
* Github Page: <github.com/ahmadnourallah>
4868
69+
4970
# License
5071
This project is licensed under the GPL-2.0 License - see the LICENSE file for details
72+
5173
# TODO
5274
* add new module
5375
* create wiki page for project

0 commit comments

Comments
 (0)