Update outdated documentation
diff --git a/CHANGELOG.md b/CHANGELOG.md index 9325962..7af6694 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md
@@ -40,6 +40,8 @@ - `./run_example.sh` has been deleted - Instead, use `PLATFORM=<platform> cargo r<arch> <your_app>`. This will build the app for your CPU architecture and platform-specific memory layout and flash it via J-Link to your board - Targets without support for atomics can be built +- The `TockAllocator` is no longer included by default and needs to to be opted-in via `--features=alloc` +- `hardware_test.rs` is now called `libtock_test.rs` to make clear that the intent is to test the correctness of `libtock-rs`, not the hardware or the kernel ## a8bb4fa9be504517d5533511fd8e607ea61f1750 (0.1.0)
diff --git a/README.md b/README.md index e58223e..18a04b1 100644 --- a/README.md +++ b/README.md
@@ -14,7 +14,7 @@ and that there can only be one application written in rust at a time and it must be installed as the first application on the board, unless you want to play games with linker scripts. -There are some `*_layout.ld` files provided that allow to run the +There are some `layout_*.ld` files provided that allow to run the examples on common boards. Due to MPU region alignment issues they may not work for applications that use a lot of RAM, in that case you may have to change the SRAM @@ -83,12 +83,12 @@ extern crate alloc; ``` -to the preamble. +to the preamble and store your example in the `examples-alloc` folder. To run on the code on your board you can use ```bash -PLATFORM=<platform> cargo r<arch> <your_app> +PLATFORM=<platform> cargo r<arch> <your_app> [--features=alloc] ``` This script does the following steps for you: