Skip to content

Commit 6e26418

Browse files
committed
add README.md with instructions on building
1 parent f1f2a8b commit 6e26418

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Arduino pluggable discovery for dfu devices
2+
3+
The `dfu-discovery` tool is a command line program that interacts via stdio. It accepts commands as plain ASCII strings terminated with LF `\n` and sends response as JSON.
4+
5+
## How to build:
6+
7+
[Docker](https://www.docker.com/) is required to build this project, along with [task](https://taskfile.dev/).
8+
9+
Just run `task download-dfu-util` to download dfu-util source code and then `task dist:<platform-to-build>`
10+
The platform to build can be one of:
11+
- Windows_32bit
12+
- Windows_64bit
13+
- Linux_32bit
14+
- Linux_64bit
15+
- Linux_ARMv6
16+
- Linux_ARMv7
17+
- Linux_ARM64
18+
- macOS_64bit
19+
- macOS_ARM64
20+
21+
The executable `dfu-discovery` will be produced inside `dist/dfu-discovery-<platform>/dfu-discovery`.
22+
23+
## Security
24+
25+
If you think you found a vulnerability or other security-related bug in this project, please read our
26+
[security policy](https://github.com/arduino/mdns-discovery/security/policy) and report the bug to our Security Team 🛡️
27+
Thank you!
28+
29+
e-mail contact: [email protected]

0 commit comments

Comments
 (0)