OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add building instructions to README.md 

This adds intructions to build the rimage tool.

Signed-off-by: Daniel Leung <danielcp@gmail.com>
This commit is contained in:
Daniel Leung 2019-11-11 18:20:34 -08:00
parent f6bf4b0d72
commit f2e92812af
1 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -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=<full path to SOF source>
$ make
$ make install
```
Note that creating the SOF firmware image requires dicitionary support.