diff --git a/.github/actions/build_ci/README.md b/.github/actions/build_ci/README.md index 9cd53aa..b76a251 100644 --- a/.github/actions/build_ci/README.md +++ b/.github/actions/build_ci/README.md @@ -30,12 +30,12 @@ This should be cleaned up in a future PR. Desktop testing is possible but is likewise messy right now. One time setup, starting in open-amp directory: -``` -$ git clone https://github.com/OpenAMP/libmetal.git +```shell +git clone https://github.com/OpenAMP/libmetal.git ``` A sequence like below will work, change the "zephyr" at the end of the docker command line to "linux" or "generic" for the other working tests -``` -$ docker build -t openamp-ci .github/actions/build_ci/ && docker run -it --rm -v$PWD:/prj -w /prj openamp-ci zephyr -$ sudo rm -rf build* zephyr* +```shell +docker build -t openamp-ci .github/actions/build_ci/ && docker run -it --rm -v$PWD:/prj -w /prj openamp-ci zephyr +sudo rm -rf build* zephyr* ``` diff --git a/README.md b/README.md index c565e03..0810034 100644 --- a/README.md +++ b/README.md @@ -148,7 +148,7 @@ instead of the full license text in the individual files: ### Signed-off-by Commit message must contain Signed-off-by: line and your email must match the change authorship information. Make sure your .gitconfig is set up correctly: - ``` + ```shell git config --global user.name "first-name Last-Namer" git config --global user.email "yourmail@company.com" ``` @@ -175,7 +175,7 @@ Before you submit a pull request to the project, verify your commit messages mee The check can be performed locally using the the gitlint command. Run gitlint locally in your tree and branch where your patches have been committed: - ``` + ```shell gitlint ``` Note, gitlint only checks HEAD (the most recent commit), so you should run it after each commit, or @@ -191,7 +191,7 @@ The Linux kernel GPL-licensed tool checkpatch is used to check coding style conf available in the scripts directory. To check your \ commits in your git branch: - ``` + ```shell ./scripts/checkpatch.pl --strict -g HEAD- ``` ### Send a pull request