From 7f69a80f0ece5abd7c09ad12933e4b9bd84a0bb7 Mon Sep 17 00:00:00 2001 From: Marek Kraus Date: Tue, 8 Nov 2022 22:17:40 +0100 Subject: [PATCH] Add building and usage instructions --- README.md | 34 +++++++++++++++++++++++++++++----- 1 file changed, 29 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6c860da..343678d 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,35 @@ Tool and library for flashing their RISC-V MCUs. # Supported MCUs -- [X] BL602 / BL604 -- [X] BL702 / BL704 / BL706 -- [ ] BL606P -- [ ] BL616 / BL618 -- [ ] BL808 +- [X] `bl60x` - BL602 / BL604 +- [X] `bl70x` - BL702 / BL704 / BL706 +- [ ] `bl606p` - BL606P +- [ ] `bl61x` - BL616 / BL618 +- [ ] `bl808` - BL808 + +# Building + +For building `blisp` command line tool, use following commands: + +```bash +mkdir build && cd build +cmake -DBLISP_BUILD_CLI=ON .. +cmake --build . +``` + +# Usage + +For BL70X, BL61X, BL808 and BL606P, connected via USB, you can use following command, which will auto-detect serial port: + +```bash +blisp --chip bl70x --reset name_of_firmware.bin +``` + +For BL60X, you need to specify also the serial port path: + +```bash +blisp --chip bl60x --reset -p /dev/ttyUSB0 name_of_firmware.bin +``` # To Do