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

README.md: add warning that forks must be created using Github 

Otherwise the SHA1 is not found and the rest of the process fails.

Problem discovered in
https://github.com/thesofproject/sof/pull/4790#discussion_r713326709

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
This commit is contained in:
Marc Herbert 2021-09-21 20:37:47 +00:00 committed by Liam Girdwood
parent 8960097403
commit c038d62804
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -7,7 +7,9 @@ to generate binary image files.
## Building
The `rimage` tool can be built with the usual CMake commands:
Most users don't build `rimage` directly but as an ExternalProject
defined by CMake in SOF. This being said, `rimage` can be built with the
usual CMake commands:
```shell
$ cmake -B build/
@ -48,6 +50,12 @@ requests.
First, push the rimage commits you want to be tested to any branch of
your rimage fork on Github. Do _not_ submit an rimage pull request yet.
Note your rimage fork must have been created using the actual "fork"
button on Github so Github is aware of the connection with the upstream
rimage repo. In the top-left corner you should see `forked from
thesofproject/rimage` under the name of your fork. If not then search
the Internet for "re-attach detached github fork".
Then, **pretend** these rimage commits have already been accepted and
merged (they have been neither) and submit to SOF a draft pull request
that updates the main SOF branch with your brand new rimage commits to