From b287cc3a1e9138f615eb3dbbc22566ba65d5f91a Mon Sep 17 00:00:00 2001 From: Kaj Forney Date: Wed, 3 Oct 2018 00:56:39 -0600 Subject: [PATCH] Update README.md Former-commit-id: 6834fc0d7e724c40361fdbee6650a089a1c4fcd5 Former-commit-id: ca4e8424560ad07043e9374264ef0aa9f95e2a7d --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e1a6d70f..918f1da5 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,22 @@ Just clone the repository, then make whatever changes you wish to make. * 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` . +When you're ready to build, run `sudo ./runme.sh` . Once it's complete, the finished image will be copied to the images/ folder. -The script will build whichever OS you are currently running, and prompt for which desktop environment and repository you wish to use. +If you run the script without any options, it will build whichever OS you are currently running, and prompt for which desktop environment and repository you wish to use. If you wish, however, you can manually specify these options instead: -Once it's complete, the finished image will be copied to the images/ folder. +* -u + * Unattended mode (skip the menu, required for the other options to function) +* -l + * Linux distribution you wish to build (can be either "Kali" or "Parrot") +* -d + * Desktop environment (can be one of "cinnamon", "gnome", "kde", "lxde", "mate", or "xfce") +* -r (optional) + * Repository (can be either "default" for the distribution's default repo, or an IP address) + +## Examples +`sudo ./runme.sh -u -l Kali -d mate -r 192.168.0.30` +This will build a Kali Linux .iso, with the MATE desktop environment, using a local repository at 192.168.0.30 + +`sudo ./runme.sh -u -l Parrot -d cinnamon` +This will build a Parrot Security OS .iso, with the Cinnamon desktop environment, using the default Parrot repository. If -r is unspecified, then the default will be used.