Updated to reflect the recent changes.
Signed-off-by: Pawel Zalewski pzalewski@thegoodpenguin.co.uk --- README.md | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md index 28f1ea2..717c83e 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ meta-morello ==============
-Meta-morello provides the layer required to build the firmware that lives on the SD card and a Morello enabled -Linux kernel for the Morello System Development Platform. +Meta-morello provides the layer required to build the firmware that lives on the SD card and a `Morello` enabled +`Linux` kernel for the Morello System Development Platform.
--Use the provided kas scripts to get all of the dependencies. --Read on how to get and use kas here [1] +- Use the provided `kas` scripts to get all of the dependencies. +- Read on how to get and use `kas` here [1]
Booting the hardware -------------------- @@ -16,26 +16,29 @@ Machines --------
The machines have been split into: -- morello-bsp for the SD card -- morello-linux-musl for the Linux image with musl being the only libc -- morello-linux-glibc for the Linux image with an arbitrary Yocto image as the rootfs, there are two system loaders: - musl for capability aware applications, glibc for all of the rest +- morello-soc for the actual hardware +- morello-fvp for running a `FVP` image using `runfvp` script @ `meta-arm`
Building images --------------------
-kas build ./kas/morello-linux-glibc.yml +kas build ./kas/morello-soc.yml
or
-kas build ./kas/morello-linux-musl.yml +kas build ./kas/morello-fvp.yml + +FVP +--- + +For instructions on how to run the image with `FVP` go here [4]
Images ------
The outputs can be found under build/temp/deploy/images: - board-firmware-sd-image.img goes on the SD card via DD -- morello-linux-image-...img goes on the USB via DD +- morello-linux-image..img goes on the USB via DD
Linux and musl-libc ------------------- @@ -45,19 +48,18 @@ The linux kernel and musl-libc are locked in sync so that the release tags from Known limitations -----------------
-- the current state of this layer is meant to be just a starting point and foundation for further development, the main aim was to have working Linux images ASAP for the community, do not expect elegant Yocto solutions yet -- the rtl_nic driver is missing from the musl image +- the current state of this layer is meant to be just a starting point and foundation for further development, the main aim was to have working `Linux` images ASAP for the community, do not expect elegant `Yocto` solutions yet
Adding new recipes ------------------
-Follow the coding style found in other layers, the aim here is to keep them consistent where possible -and very easy to read. Follow the order found in the "headers" of each recipe and in general. +Follow the coding style found in other layers, the aim here is to keep them consistent where possible +and very easy to read. Follow the order found in the "headers" of each recipe and in general.
-.bb recipes that come from Morello gitlab and are Morello "edits"" of upstream inherit the name Morello in the recipe: package-name-morello -.bbappends do not need to do this even if they come from Morello gitlab as they would only change SRC_URI +`.bb` recipes that come from Morello gitlab and are Morello "edits"" of upstream inherit the name Morello in the recipe: package-name-morello +`.bbappends` do not need to do this even if they come from Morello gitlab as they would only change `SRC_URI`
-Whether to append or start a new recipe is up to the designer, whatever is the easiest. +Whether to append or start a new recipe at this stage is up to the designer, whatever is the easiest.
Mailing list @@ -71,3 +73,4 @@ References [1] https://kas.readthedocs.io/en/latest/ \ [2] https://developer.arm.com/documentation/den0132/0100/Setting-up-the-Morello-... \ [3] https://developer.arm.com/documentation/102278/0001/?lang=en +[4] https://github.com/jonmason/meta-arm/blob/master/documentation/runfvp.md \ No newline at end of file