Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitrykos authored Aug 24, 2023
1 parent d06de03 commit a523b08
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,33 @@ void RunExample()
* Arm Cortex-M7
- [NXP MIMXRT1050 EVKB](http://www.google.com/search?q=MIMXRT1050-EVKB)
## Build
It is fairly easy to build and run examples without even having embedded hardware on your hands. You will need these tools to run examples on your PC:
* [Eclipse Embedded CDT (C/C++ Development Tools)](https://projects.eclipse.org/projects/iot.embed-cdt)
**Arm platform:**
* Compiler: [The xPack GNU Arm Embedded GCC](https://xpack.github.io/dev-tools/arm-none-eabi-gcc)
* Emulator: [The xPack QEMU Arm](https://xpack.github.io/dev-tools/qemu-arm)
In case of NXP MCU you will only need [MCUXpresso IDE](https://www.nxp.com/design/software/development-software/mcuxpresso-software-and-tools-/mcuxpresso-integrated-development-environment-ide:MCUXpresso-IDE) which is comes with bundled GCC compler.
**RISC-V platform:**
* Compiler: [The xPack GNU RISC-V Embedded GCC](https://xpack.github.io/dev-tools/riscv-none-elf-gcc)
* Emulator: [The xPack QEMU RISC-V](https://xpack.github.io/dev-tools/qemu-riscv)
If you are working with only Arm platform then you only need Arm-related tools.
Eclipse examples are located in the ```build/example/project/eclipse``` folder and sorted by platform:
* **stm** - Arm platform, examples based on STM32 microcontrollers and can be executed on QUEMU virtual machine or directly on hardware if you have corresponding board.
* **risc-v** - RISC-V platform, examples based on QEMU virtual machine.
* **x86** - x86 platform, examples are executed on x86 CPU.
Additionally, NXP MCUXpresso examples are provided in ```build/example/project/nxp-mcuxpresso``` folder which are compatible with NXP Kinetis® K66, Kinetis® K26 and NXP i.MX RT1050 MCUs and can be executed on corresponding evaluation boards.
## Porting:
You are welcome to port STK to a new platform and offer a patch. The platform
dependent files are located in: ```/stk/src/arch``` and ```/stk/include/arch``` folders.
dependent files are located in: ```/stk/src/arch``` and ```/stk/include/arch``` folders.

0 comments on commit a523b08

Please sign in to comment.