From f2e92812afa18ad6d369dba9bae395de2a17790d Mon Sep 17 00:00:00 2001 From: Daniel Leung Date: Mon, 11 Nov 2019 18:20:34 -0800 Subject: [PATCH] Add building instructions to README.md This adds intructions to build the rimage tool. Signed-off-by: Daniel Leung --- README.md | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c5c67ede5..4b484048d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,34 @@ # rimage -DSP firmware image creation and signing tool + +`rimage` is a DSP firmware image creation and signing tool targeting +the DSP on certain Intel System-on-Chip (SoC). This is used by +the [Sound Open Firmware (SOF)](https://github.com/thesofproject/sof) +to generate binary image files. + +## Building + +The `rimage` tool can be built with or without logging dictionary +support, where such support is required to decipher the log messages +produced the the SOF firmware. + +#### Build without dictionary support: + +```shell +$ ./configure +$ make +$ make install +``` + +#### Build with dictionary support: + +To build `rimage` with dictionary support, the SOF source is required. +First, clone the SOF source tree from +[here](https://github.com/thesofproject/sof). Then, do: + +```shell +$ ./configure --with-sof-source= +$ make +$ make install +``` + +Note that creating the SOF firmware image requires dicitionary support.