small update to instructions in README
diff --git a/README.md b/README.md index 36be4b0..0c1289c 100644 --- a/README.md +++ b/README.md
@@ -26,20 +26,20 @@ 1. Ensure you have [rustup](https://www.rustup.rs/) installed. -1. Clone the repository: +2. Clone the repository: ```shell git clone https://github.com/tock/libtock-rs cd libtock-rs ``` -1. Install the dependencies: +3. Install the dependencies: ```shell make setup ``` -1. Use `make` to compile and run an example app. +4. Use `make` to build examples ```shell make nrf52 # Builds all examples for the nrf52 platform @@ -53,6 +53,10 @@ make opentitan FEATURES=alloc # Builds all examples for the OpenTitan platform, with alloc feature enabled ``` + ```bash + make flash-hail EXAMPLE=blink # Flash the example 'blink' program to the hail platform + ``` + For an unknown platform, you may have to create your own memory layout definition. Place the layout definition file at `boards/layout_<platform>.ld` and do not forget to enhance the `tockloader_flags` dispatching section in `tools/flash.sh`. You are welcome to create a PR, s.t. the number of supported platforms grows. ## Using libtock-rs @@ -79,13 +83,13 @@ to the preamble and store your example in the `examples-alloc` folder. -To run on the code on your board you can use +To build the examples for your board you can use ```shell make <platform> [FEATURES=alloc] ``` -The example can also be flashed to the board by running: +A program can be flashed to your board after the build process by running: ```shell make flash-<platform> EXAMPLE=<example>