Update Sun Jan 3 05:19:30 AM CST 2021

README.md

@@ -261,43 +261,96 @@
 - example command line var: --help or -help or help will catch help and works for all valid command line arguements
   anything other the command line arugement catch exits and displays help
 
-What pimpmykali does:
+# Menu Breakdown of Pimpmykali
-- BlindPentesters The_Essentials tools and utilities collection
+
-  - menu option B
+Menu breakdown of what pimpmykali does: (section is being updated - section is not complete)
-- blank/black screen after login
+
-  - pimpmyupgrade menu option #9
+- Menu Option 1 - Fix missing
-  - virtualbox shared folder permission denied - fixed
+  - fix_sources
-  - auto-detection of virtualbox or vmware hypervisor
+    - uncomment #deb-src from /etc/apt/sources.list
-  - added hold to metasplot-framework from being upgraded due to msf5 downgrade
+  - python-pip installation via curl
-    - eventually this hold will be removed
+  - python3-pip installed
-- metasploit-framework downgrade (menu option D) msf6 -> msf5 downgrade    
+  - seclists installed
-- python-pip installation via curl
+  - gedit installed (feature request)
-- python3-pip installed
+  - flameshot installed (feature request)
-- seclists installed
+  - locate installed (feature request)
-- golang installed
+  - fix_rockyou function
-  - added GOPATH statements to both .bashrc and .zshrc
+    - gunzip's /usr/share/wordlists/rockyou.gz to /usr/share/wordlists/rockyou.txt
-- gedit installed (feature request)
+  - fix_golang function
-- flameshot installed (feature request)
+    - installs golang
-- locate installed (feature request)
+    - adds golang GOPATH to .bashrc and .zshrc
-- kali-root-login not installed and re-enables root login
+  - installs htop
-  - reworked and added prompt
+  - installs python requests
-  - 1.1.2 - added prompt to copy /home/kali to /root
+  - installs python xlrd 
-  - 1.1.3 - added "Are you sure?" prompt
+
-- nmap scripts clamav-exec.nse and http-shellshock.nse - fixed
+- Menu Option 2 - Fix smb.conf
-- impacket-0.9.19
+  - Fix /etc/samba/smb.conf
+    - adds client min protocol = CORE  below [global]
+    - adds client max protocol = SMB3  below [global]
+
+- Menu Option 3 - Fix Golang
+  - Installs golang
+    - checks for GOPATH in .bashrc and .zshrc
+      - if GOPATH is found, adds nothing
+      - if not found, adds GOPATH statements to both .zshrc and .bashrc
+
+- Menu Option 4 - Fix Grub
+  - adds mitigations=off to GRUB_CMDLINE_LINUX_DEFAULT
+    - disables spectre and meltdown mitigations
+
+- Menu Option 5
+  - Installs Impacket-0.9.19
+
+- Menu Option 6 - Enable root login
+  - installs kali-root-login
+    - prompts for root password
+    - copy /home/kali to /root prompt (1.1.2)
+      - added are you sure? prompt to copy /home/kali to /root prompt (1.1.3)
+
+- Menu Option 7
+  - installs Atom text editor
+
+- Menu Option 8 - Fix Nmap
+  - wget 2 nmap script fixes
+    - clamav-exec.nse
+    - http-shellshock.nse (Thank you Alek!)
+
+Menu Option 9 - Pimpmyupgrade
+  - additional notes will be added
+  - performs apt ugprade and holds back metasploit-framework from being upgraded
+    - due to msf6 to msf5 downgrade
+  - fix : black screen after login
+    - add additional details here
+  - fix : Hypervisor detection (vmware, virtualbox, qemu/libvirt)
+    - add additional details here
+  - fix : virtualbox shared folder fix applied     
+
+Menu Option 0 - Fix all
+  - Executes Functions 1 thru 8 Only
+
+- Menu option N  (New Users/New VM's Should start here!)
+  - executes fix all ( menu options 1 thru 8 )
+  - executes menu option D (downgrad metasploit)
+  - executes menu opiion 9 (pimpmyupgrade)
+
+- Menu Option B    
+  - BlindPentesters The_Essentials tools and utilities collection
+    - Install all of BlindPentesters favorite tools and utilities to /opt! (aprox 8GB)
+    - For a full list of the_essentials.sh script and its inner workings
+    - https://github.com/blindpentester/the-essentials
+
+- Menu Option D - Downgrade metasploit-framework from 6 to 5
+    - included in menu option N
+    - downgrades metasploit-framework (msfconsole) from msf6 to msf5
+      - this is a temporary solution and will eventually be removed
+
+- Menu Option ! - Nuke Impacket (yes its literally the ! character)        
   - removes any prior installation of impacket (gracefully and forcefully)
     - installs impacket-0.9.19
     - installs python-pip via curl
     - installs python wheel
-- impacket nuke function
     - menu option ! (its literally the ! character)
     - 1 warning screen (2nd warning screen removed)
-- /etc/samba/smb.conf
-  - adds the 2 lines below [global] for min max protocol
-  - client min protocol = CORE
-  - client max protocol = SMB3
-- grub added detection of default /etc/default/grub
-  - added mitigations=off
 
 # TODO   
   - cleaned up todo list