From fe22cf70fd1dd9e03cd22858b1bcc8561c725a75 Mon Sep 17 00:00:00 2001 From: K Gray <64373011+Kgray44@users.noreply.github.com> Date: Sun, 27 Nov 2022 08:28:53 -0500 Subject: [PATCH] Update Readme.md to include instructions Includes instructions for programming now. --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index 8cc8c49..8ae106d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # Ionizing-Radiation-Detector This code is for building an Ionizing Radiation Detector using Arduino! + +# How to code the Microcontroller + +What you need: +* USB-C cable +* PC + +## Step 1 +First, download the Arduino IDE from here: +https://downloads.arduino.cc/arduino-ide + +## Step 2 +Once you have the IDE downloaded, download this Ionizing Radiation Detector code by clicking [here](https://github.com/Kgray44/Ionizing-Radiation-Detector/archive/refs/heads/main.zip). + +## Step 3 +Once the code is downloaded, open the downloaded folder and click on the "geiger.ino" file. It will automatically open in the Arduino IDE. Be patient though, as this may take up to a minute to open. + +## Step 4 +You have to select the correct microcontroller and USB port before you are able to program. Click on *tools / board / Arduino AVR Boards / Arduino Leonardo*. That sets the board to Leonardo (Atmega32-U4). Now, click on *tools / port / '/dev/cu/usbmodem14101'* (''this is the usual port on MacOS for a Leonardo). + +## Step 5 +Now, plug the USB cable into your PC and into the Leonardo. + +## Step 6 +Click the arrow (upload) button to the top left of the sketch, and it will program the board! + +## Step 7 +If you click the magnifying glass icon to the top right of the sketch, it will open the Serial Monitor. This is great for debugging!