Create README.md

Former-commit-id: 39446deebc
This commit is contained in:
Kaj Forney 2018-09-26 15:55:30 -06:00 committed by GitHub
parent 65945de36d
commit f9a83f83f4

16
README.md Normal file
View file

@ -0,0 +1,16 @@
# Pentest Distro Builder
This script automates the process of building the most common pentesting Linux distributions, Kali Linux and Parrot Security OS.
## Running
Just clone the repository, then make whatever changes you wish to make.
* .deb files in the debs/ folder will be installed into the image.
* Files in the filesystem/ folder will be copied to the system.
* Add any extra software from the repository you wish to install to the config/software.list.chroot file.
When you're ready to build, run `sudo ./runme.sh` .
The script will build whichever OS you are currently running, and prompt for which desktop environment and repository you wish to use.
Once it's complete, the finished image will be copied to the images/ folder.