update README instructions and formatting (#9)

add badges and useful resources to README
change payload  to open notepad and type "Hello World!" in Windows
fix comments in duckyinpython.py
rename "pics" folder to "images"
update setup mode image to a clearer one

README.md

@@ -1,37 +1,62 @@
-# pico-ducky
+<h1 align="center">pico-ducky</h1>
-Create a USB Rubber Ducky like device using a Raspberry PI Pico
 
-Download circuitpython for pico board:
+<div align="center">
-https://circuitpython.org/board/raspberry_pi_pico/
+  <strong>Make a cheap but powerful USB Rubber Ducky with a Raspberry Pi Pico</strong>
+</div>
 
-Plug the Pico board into a USB port.
+<br />
-The board will show up as a removable media device.
-Copy the UF2 file to the root of the media device.
 
-The Pico board will reboot after installing the firmware image.
+<div align="center">
+  <img alt="GitHub code size in bytes" src="https://img.shields.io/github/languages/code-size/dbisu/pico-ducky">
+  <img alt="GitHub license" src="https://img.shields.io/github/license/dbisu/pico-ducky">
+  <a href="https://github.com/dbisu/pico-ducky/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/dbisu/pico-ducky"></a>
+  <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/dbisu/pico-ducky">
+  <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/dbisu/pico-ducky">
+</div>
 
-Download additional libraries:
+<br />
-https://github.com/adafruit/Adafruit_CircuitPython_Bundle
 
-https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/tag/20210130
+## Install
 
-from zip file, unpack adafruit_hid folder.
+Install and have your USB Rubber Ducky working in less than 5 minutes.
-copy adafruit_hid to the lib folder.
 
-Circuitpy HID
+1. Download [CircuitPython for the Raspberry Pi Pico](https://circuitpython.org/board/raspberry_pi_pico/).
-https://learn.adafruit.com/circuitpython-essentials/circuitpython-hid-keyboard-and-mouse
 
+2. Plug the device into a USB port. It will show up as a removable media device named `RPI-RP2`.
 
-# Ducky Script Python
+3. Copy the downloaded `.uf2` file to the root of the Pico (`RPI-RP2`). The device will reboot and after a second or so, it will reconnect as `CIRCUITPY`.
-Copy duckyinpython.py to the root of the media device as code.py
 
-$ cp duckyinpython.py /<path to media device>/code.py
+4. Download `adafruit-circuitpython-bundle-6.x-mpy-YYYYMMDD.zip` [here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest) and extract it outside the device.
 
-Copy your Ducky Script file as payload.dd
+5. Navigate to `lib` in the recently extracted folder and copy `adafruit_hid` to the `lib` folder in your Raspberry Pi Pico.
 
-$ cp <duckyscriptfile> /path to media device>/payload.dd
+6. Click [here](https://raw.githubusercontent.com/dbisu/pico-ducky/main/duckyinpython.py), press CTRL + S and save the file as `code.py` in the root of the Raspberry Pi Pico, overwriting the previous file.
 
-# NEW: added support for a programming switch.  
+7. Find a script [here](https://github.com/hak5darren/USB-Rubber-Ducky/wiki/Payloads) or [create your own one using Ducky Script](https://github.com/hak5darren/USB-Rubber-Ducky/wiki/Duckyscript) and save it as `payload.dd` in the Pico.
-Tie pin 0 (GPIO0) to pin 3 (GND) to not automatically run payloads.
+
-Easiest way to do this is to add a jumper wire between those pins.
+8. Be careful, if your device isn't in [setup mode](#setup-mode), the device will reboot and after half a second, the script will run. 
-![jumper wire](pics/jumper.png)
+
+### Setup mode
+
+To edit the payload, enter setup mode by connecting the pin 1 (`GP0`) to pin 3 (`GND`), this will stop the pico-ducky from injecting the payload in your own machine.
+The easiest way to so is by using a jumper wire between those pins as seen bellow.
+
+![Setup mode with a jumper](images/setup-mode.png)
+
+## Useful links and resources
+
+### Docs 
+
+[CircuitPython](https://circuitpython.readthedocs.io/en/6.3.x/README.html)
+
+[CircuitPython HID](https://learn.adafruit.com/circuitpython-essentials/circuitpython-hid-keyboard-and-mouse)
+
+[Ducky Script](https://github.com/hak5darren/USB-Rubber-Ducky/wiki/Duckyscript)
+
+### Video tutorials
+
+[pico-ducky tutorial by **NetworkChuck**](https://www.youtube.com/watch?v=e_f9p-_JWZw)
+
+[USB Rubber Ducky playlist by **Hak5**](https://www.youtube.com/playlist?list=PLW5y1tjAOzI0YaJslcjcI4zKI366tMBYk)
+
+[CircuitPython tutorial on the Raspberry Pi Pico by **DroneBot Workshop**](https://www.youtube.com/watch?v=07vG-_CcDG0)

duckyinpython.py

@@ -27,8 +27,8 @@ def convertLine(line):
     newline = []
     print(line)
     for j in range(len(keycodeCommands)):
-			if line.find(duckyCommands[j]) != -1:
+		    if line.find(duckyCommands[j]) != -1:
-				newline.append(keycodeCommands[j])
+		    	newline.append(keycodeCommands[j])
     print(newline)
     return newline
 
@@ -42,7 +42,7 @@ def sendString(line):
 
 def parseLine(line):
     if(line[0:3] == "REM"):
-        #comments - ignore
+        # ignore ducky script comments
         print("")
     elif(line[0:5] == "DELAY"):
         time.sleep(float(line[6:])/1000)
@@ -59,19 +59,18 @@ def parseLine(line):
 kbd = Keyboard(usb_hid.devices)
 layout = KeyboardLayoutUS(kbd)
 
-#sleep a the start to allow the device to be recognized by the host computer
+# sleep at the start to allow the device to be recognized by the host computer
 time.sleep(.5)
 
-
+# check GP0 for setup mode
-# check GPIO0 for program switch
+# see setup mode for instructions
-# easiest way to implement is to run a jumper from pin 0 (GPIO0) to pin3 (GND)
 progStatus = False
 progStatusPin = digitalio.DigitalInOut(GP0)
 progStatusPin.switch_to_input(pull=digitalio.Pull.UP)
 progStatus = progStatusPin.value
 defaultDelay = 0
 if(progStatus == True):
-    #not in programming state, run script file
+    # not in setup mode, inject the payload
     duckyScriptPath = "payload.dd"
     f = open(duckyScriptPath,"r",encoding='utf-8')
     print("Running payload.dd")
@@ -89,6 +88,6 @@ if(progStatus == True):
             previousLine = line
         time.sleep(float(defaultDelay)/1000)
 
-    print("Done...")
+    print("Done")
 else:
-    print("Update new payload file")
+    print("Update your payload")

payload.dd

@@ -1,4 +1,6 @@
-REM Testing Script
+REM The next four lines open Notepad in Windows and type "Hello World!"
-STRING atom test.txt
+GUI r
-DELAY 2000
+STRING notepad
-GUI L
+ENTER
+DELAY 250
+STRING Hello World!