Skip to content

Commit 1267a7c

Browse files
author
dorranh
committed
Update README
1 parent 6d9e480 commit 1267a7c

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,26 @@
11
# Bluetooth-Arduino-Prosthetic-Control
22
This sketch is to be used in conjunction with Mediapipe Prosthetic Hand Controller
3+
4+
## Supported hardware
5+
6+
This sketch is currently designed to work with the following Arduino boards:
7+
* [adafruit Feather ESP32](https://www.adafruit.com/product/3405)
8+
9+
## Installation
10+
11+
### Command Line
12+
To build this sketch on the command line, you will need the following tools installed. Please see their respective installation guides for instructions on how to install them.
13+
14+
1. [make](https://www.gnu.org/software/make/) - Installation of `make` is OS-dependent. The provided link includes a download page for installing make on OSX and Linux. (See [here](https://stackoverflow.com/questions/32127524/how-to-install-and-use-make-in-windows) for more info on installing on Windows).
15+
1. [arduino_cli](https://arduino.github.io/arduino-cli/latest/)
16+
17+
With those installed you can build the sketch with:
18+
19+
```shell
20+
$ make build
21+
```
22+
For deploying the sketch please see the additional info on the [arduino-cli site](https://arduino.github.io/arduino-cli/latest/getting-started/#compile-and-upload-the-sketch).
23+
24+
### Arduino IDE
25+
26+
TODO

0 commit comments

Comments
 (0)