Skip to content

Commit

Permalink
Improved README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mtrzc0 authored Jul 7, 2023
1 parent 1f30282 commit 8aa0506
Showing 1 changed file with 29 additions and 24 deletions.
53 changes: 29 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
# keybox-arduino
This repo contains the software for the Keybox device

This repository contains the software for the Keybox device.

## Requirements

### Software
- [ ] [Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360019833020-Download-and-install-Arduino-IDE)
- [ ] [Servo library](https://www.arduino.cc/reference/en/libraries/servo/)
---
- [Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360019833020-Download-and-install-Arduino-IDE)
- [Servo library](https://www.arduino.cc/reference/en/libraries/servo/)

### Hardware
- [ ] Arduino Uno R3 (could be clone)
- [ ] Green LED
- [ ] Red LED
- [ ] Push button
- [ ] Servo SG 90
- [ ] 220 Ohm resistor x3
- Arduino Uno R3 (can be a clone)
- Green LED
- Red LED
- Push button
- Servo SG 90
- Three 220 Ohm resistors

[Click here to see the circuit](https://imgur.com/a/XT39uWD)
[Circuit Diagram](https://imgur.com/a/XT39uWD)

## Installation
> This manual assumes you know how to how to use arduino IDE and your circuit is correct

**Note: This manual assumes that you are familiar with using Arduino IDE and have correctly set up your circuit.**

### CLI
---
- Clone repo to your directory using ` git clone `
- Open Arduino IDE in directory with cloned repo
- Compile sketch
- Upload to the board

### Other
---
- Download repo and extract it to your directory
- Open Arduino IDE in directory with downloaded repo
- Compile sketch
- Upload to the board
1. Clone the repository to your local directory using the command: `git clone [repository URL]`
2. Open Arduino IDE and navigate to the directory where the repository was cloned.
3. Compile the sketch.
4. Upload the sketch to the Arduino board.

### Manual Installation
1. Download the repository and extract its contents to your local directory.
2. Open Arduino IDE and navigate to the directory where the repository was extracted.
3. Compile the sketch.
4. Upload the sketch to the Arduino board.

By following these steps, you will be able to set up and run the Keybox software on your Arduino device.

0 comments on commit 8aa0506

Please sign in to comment.