From 857de3fb7eb4d5ca17f42cffa64d3a250744a4e8 Mon Sep 17 00:00:00 2001 From: Robert Lipe Date: Sun, 23 Oct 2022 00:31:47 -0400 Subject: [PATCH] Add additional collected wisdom to README.md. --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 57ebf5a..8388771 100644 --- a/README.md +++ b/README.md @@ -14,4 +14,35 @@ Tool and library for flashing their RISC-V MCUs. - [ ] Another code style - [ ] Finalize API -- [ ] SDIO and JTAG support \ No newline at end of file +- [ ] SDIO and JTAG support + +# Build + +This project is not self-contained. After you check out the master project +from GitHub, you must fetch the additional vendor libraries via: +$ git submodule update --init --recursive + +If vendor/argtable3 and vendor/libserialport/ are empty, this step has +failed and should be investigated. + +# Usage + + blisp write -c [-p ] + blisp [--help] [--version] + +A typical invocation may therefore be: + + blisp write -c bl70x -p /dev/tty.usbmodem0000000200001 + +If you wish to see a painful level of debugging, set the environmental +variable LIBSERIALPORT_DEBUG before running. You can either export this +in your shell or change it for a single run via + + LIBSERIALPORT_DEBUG=y ./a.out write -c bl70x -p /dev/tty.usbmodem0000000200001 + +Because this is done at the lowest level of serial communication, the +displays aren't packet-aware or know about the chip's command set or such. +This is really only useful for debugging systems-level issues withing +the device or blisp itself. + +