Skip to content

Commit 5bce061

Browse files
committed
added readme information for the script
1 parent 12dddbe commit 5bce061

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ The usual way to set up a cross-compile project in CMake is to specify a CMake t
88
RTEMS version, RTEMS prefix and the `pkgconfig` utility to set up the RTEMS environment properly so that application developers can focus on their application.
99

1010
This is still a prototype. Simple applications have been tested, but no larger projects have been compiled with this build support yet.
11-
The compilation of simple applications was tested on Windows 10 and Ubuntu 20.04
11+
The compilation of simple applications was tested on Windows 10 and Ubuntu 20.04.
12+
Improvements, suggestions and pull requests are welcome :-)
1213

1314
## How to use
1415

@@ -67,6 +68,11 @@ The RTEMS CMake build support can be configured either by passing configuration
6768
- `RTEMS_TOOLS`: Can be specified if the RTEMS tools folder. Can be different from the prefix but will be equal to the prefix for most users.
6869
- `RTEMS_PATH`: Folder containing the RTEMS installation (BSPs). Can be different from the prefix but will be equal to the prefix for most users.
6970

71+
## CMake build configuration helper
72+
73+
A small python script is provided in the build support to allow easier configuration of the CMake build systems when using RTEMS. Call `cmake_build_config.py --help` to get
74+
some information how to configure a build. Python 3 has to be installed to use this script.
75+
7076
## Extending the build system support
7177

7278
It is possible to read the pkfconfig files now, so extending the manual build configuration might not be necessary in the future.
@@ -75,7 +81,7 @@ If this becomes necessary after all, follow these steps:
7581

7682
Extract the necessary compiler and linker flags for the RTEMS build from the pkgconfig file for the specific BSP. This file will generally be located inside the `lib/pkgconfig` folder of the RTEMS tools folder. Add these flags manually before the `project` file call (see `RTEMSToolchain.cmake` for examples) for your specific BSP.
7783

78-
## Example
84+
## Examples
7985

8086
See https://github.com/rmspacefish/rtems-demo/tree/master/applications/hello for an example. This is the Hello World project taken from the RTEMS quick start guide,
81-
but compiled using RTEMS. The repository also contains instructions on how to build the RTEMS tools if required and all specific steps to build with CMake.
87+
but compiled using RTEMS. The repository also contains instructions on how to build the RTEMS tools if required and all specific steps to build with CMake and a blinky example for the STM32H743ZI-Nucleo board.

0 commit comments

Comments
 (0)