doc: add README.md

This commit is contained in:
Moritz Bitsch 2024-12-28 20:07:22 +01:00
parent 65b8841c4c
commit ed67934fd1
No known key found for this signature in database

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# Meshtastic ESP Ota
This small program is able to update esp32 based meshtastic devices using the bleota introduced in meshtastic v2.3.1.4.
## Compilation
This project is written in rust and uses cargo to build. Some system libraries are required for building (on linux bluetooth related):
cargo build
You can also use nix to build the included flake:
nix build
# Usage
Call the compiled binary with the target device name as first parameter and path to the update firmware .bin as second path
meshtastic-esp-ota Meshtastic_XXXX update.bin