Skip to content

Commit b133289

Browse files
committed
add more detail to readme
1 parent 5553c64 commit b133289

File tree

1 file changed

+33
-1
lines changed

1 file changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,36 @@
22

33
**WIP:** This project is currently a work in progress
44

5-
A modern tool for uploading to micro controllers like Arduinos and ESP devices, written in typescript with automated tests.
5+
A modern tool for uploading to micro controllers like Arduinos and ESP devices, written in typescript with automated tests.
6+
7+
## Project Objectives
8+
9+
This project aims to achieve the following:
10+
- Production ready
11+
- Written in TypeScript
12+
- Automated testing against real devices
13+
- Browser friendly
14+
- SerialPort Agnostic (connection is passed through)
15+
- Small bundle size?
16+
- Developer Friendly
17+
- Promises
18+
- Linting
19+
- Documentation
20+
- Modern development practices
21+
- Board Variety
22+
- Support most arduino protocols
23+
- Support ESP devices
24+
- Platform for easy addition of new protocols
25+
26+
## Get in touch
27+
You can contact me in the #multitool-general channel of the duinoapp discord
28+
29+
[![Join Discord](https://i.imgur.com/Gk2od5o.png)](https://discord.gg/FKQp7N4)
30+
31+
## Influences
32+
This project aims to be a full recode based on existing projects before it:
33+
- [avrgirl-arduino](https://github.com/noopkat/avrgirl-arduino)
34+
- [stk500v1](https://github.com/jacobrosenthal/js-stk500v1)
35+
- [stk500v2](https://github.com/Pinoccio/js-stk500)
36+
- [chip.avr.avr109](https://github.com/tmpvar/chip.avr.avr109)
37+
- [esptool-js](https://github.com/espressif/esptool-js)

0 commit comments

Comments
 (0)