soc-tools: Update README.md install section Document some more of the dependencies. Signed-off-by: Linus Walleij <linusw@kernel.org>
diff --git a/README.md b/README.md index 30850b0..5e983ec 100644 --- a/README.md +++ b/README.md
@@ -29,8 +29,39 @@ ## Installation -1. Go to the "soc" Linux kernel repository. -2. path/soc-tools/install.sh +1. Clone the SoC kernel tree using SSH so you get an authenticated + and writeable origin: + git clone ssh://git@gitolite.kernel.org/pub/scm/linux/kernel/git/soc/soc.git +2. Clone soc-tools: + git clone git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc-tools.git +3. Clone next-analysis: + git clone https://github.com/krzk/next-analysis.git +4. Go to the "soc" Linux kernel repository. +5. Link the tool trees into your source tree for convenience: + ln -s /path/to/soc-tools soc-tools + ln -s /path/to/next-analysis next-analysis +6. soc-tools/install.sh to install the git hooks +7. Install tools used by the maintainer scripts: + pipx install --user pwclient + apt-get install / dnf -y mutt +8. Put the required configuration into $HOME/.pwclientrc + something like: + --------8<----------8<--------- + [options] + default = linux-soc + + [linux-soc] + backend = rest + url = https://patchwork.kernel.org/api/1.2/ + project = linux-soc + token = 123456789abcdef... + --------8<----------8<--------- + The token is obtained from the kernel.org patchwork web UI, righ hand + user drop-down, "View profile", "Authentication" shows the API token + for your user. +9. In addition to this you need build scripts to build each target SoC + architecture for testing. People use different things and different + compilers (GCC or LLVM/Clang). ## Uninstallation