Merge #176 176: small update to instructions in README r=jrvanwhy a=JOE1994 I initially misunderstood the README directions and thought that simply running ```make hail``` would build all examples in this repo and flash them to my device. (#175 ) Although it was on part my bad for misunderstanding the README , I made a small update to make the directions a bit more clear. Please feel free to close this PR if you feel this change is unnecessary. Thank you for reviewing this PR :+1: Co-authored-by: JOE1994 <joseph942010@gmail.com>
diff --git a/README.md b/README.md index 36be4b0..a2bad2b 100644 --- a/README.md +++ b/README.md
@@ -39,7 +39,7 @@ make setup ``` -1. Use `make` to compile and run an example app. +1. 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: +An example can be flashed to your board after the build process by running: ```shell make flash-<platform> EXAMPLE=<example>