Skip to content

Use shell blocks for readme #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sipke wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Use shell blocks for readme #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec52410
github actions:README: add some new lines and code block for clarity
Aug 30, 2026
4a105d4
README: use shell block for commands in Markdown files
Aug 30, 2026
6b78981
README: un-indent code block to avoid showing tag lines
Aug 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .github/actions/build_ci/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,20 @@ This action test builds for a specified target.
### `target`

**Required** the build target. Default `"linux"`.

The supported targets are:
```
linux
generic arm
freertos
zephyr
```


## Example usage

```
uses: ./.github/actions/build_ci
with:
target: freertos
target: freertos
```
61 changes: 31 additions & 30 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ in cmake command line to disable the option.
## Build Steps

### Building for Linux Host
```
$ git clone https://github.com/OpenAMP/libmetal.git
$ mkdir -p libmetal/<build directory>
$ cd libmetal/<build directory>
$ cmake ..
$ make VERBOSE=1 DESTDIR=<libmetal install location> install
```shell
git clone https://github.com/OpenAMP/libmetal.git
mkdir -p libmetal/<build directory>
cd libmetal/<build directory>
cmake ..
make VERBOSE=1 DESTDIR=<libmetal install location> install
```

### Cross Compiling for Linux Target
Expand Down Expand Up @@ -69,11 +69,11 @@ example toolchain file:
```
* Note: other toolchain files can be found in the `cmake/platforms/` directory.
* Compile with your toolchain file.
```
$ mkdir -p build-libmetal
$ cd build-libmetal
$ cmake <libmetal_source> -DCMAKE_TOOLCHAIN_FILE=<toolchain_file>
$ make VERBOSE=1 DESTDIR=<libmetal_install> install
```shell
mkdir -p build-libmetal
cd build-libmetal
cmake <libmetal_source> -DCMAKE_TOOLCHAIN_FILE=<toolchain_file>
make VERBOSE=1 DESTDIR=<libmetal_install> install
```
* Note: When building baremetal for Xilinx 2018.3 or earlier environments,
add -DXILINX_PRE_V2019 to your CMake invocation. This will include the
Expand All @@ -91,17 +91,17 @@ running a Zephyr environment.

As Zephyr uses CMake, we build libmetal library and test application as targets
of Zephyr CMake project. Here is how to build libmetal for Zephyr:
```
$ export ZEPHYR_TOOLCHAIN_VARIANT=zephyr
$ export ZEPHYR_SDK_INSTALL_DIR=<where Zephyr SDK is installed>
$ source <git_clone_zephyr_project_source_root>/zephyr-env.sh
```shell
export ZEPHYR_TOOLCHAIN_VARIANT=zephyr
export ZEPHYR_SDK_INSTALL_DIR=<where Zephyr SDK is installed>
source <git_clone_zephyr_project_source_root>/zephyr-env.sh

$ cmake <libmetal_source_root> -DWITH_ZEPHYR=on -DBOARD=qemu_cortex_m3 \
cmake <libmetal_source_root> -DWITH_ZEPHYR=on -DBOARD=qemu_cortex_m3 \
[-DWITH_TESTS=on]
$ make VERBOSE=1 all
make VERBOSE=1 all
# If we have turned on tests with "-DWITH_TESTS=on" when we run cmake,
# we launch libmetal test on Zephyr QEMU platform as follows:
$ make VERBOSE=1 run
make VERBOSE=1 run
```

## Interfaces
Expand Down Expand Up @@ -280,18 +280,18 @@ compatible with version the
is the license covering the OpenAMP distribution as a whole. In practice, use
the following tag instead of the full license text in the individual files:

```
SPDX-License-Identifier: BSD-3-Clause
```
```
SPDX-License-Identifier: BSD-3-Clause
```
### Signed-off-by

Commit messages must contain Signed-off-by: line and your email must match the
change authorship information. Make sure your .gitconfig is set up correctly:

```
git config --global user.name "first-name Last-Namer"
git config --global user.email "yourmail@company.com"
```
```shell
git config --global user.name "first-name Last-Namer"
git config --global user.email "yourmail@company.com"
```

### Assisted-by
When AI tools are used to contribute to the OpenAMP project, proper attribution helps
Expand Down Expand Up @@ -319,7 +319,9 @@ command.
Run gitlint locally in your tree and branch where your patches have been
committed:

```gitlint```
```shell
gitlint
```

Note, gitlint only checks HEAD (the most recent commit), so you should run it
after each commit, or use the --commits option to specify a commit range
Expand All @@ -336,10 +338,9 @@ conformity. Checkpatch is available in the scripts directory.

To check your \<n\> commits in your git branch:

```
./scripts/checkpatch.pl --strict -g HEAD-<n>

```
```shell
./scripts/checkpatch.pl --strict -g HEAD-<n>
```
### Send a pull request

We use standard GitHub mechanism for pull request. Please refer to GitHub
Expand Down
Loading