From 2a379b789c1bcba4934e0fe1da4017f07bc703be Mon Sep 17 00:00:00 2001 From: Nathaniel Graff Date: Wed, 16 Jan 2019 11:32:18 -0800 Subject: Document standalone target Add documentation to README and `make help` Signed-off-by: Nathaniel Graff --- Makefile | 5 +++++ README.md | 13 +++++++++++++ 2 files changed, 18 insertions(+) diff --git a/Makefile b/Makefile index a6033b4..8ac9564 100644 --- a/Makefile +++ b/Makefile @@ -92,6 +92,11 @@ help: @echo " debug BSP=mee [PROGRAM=$(PROGRAM) BOARD=$(BOARD)]:" @echo " Launch OpenOCD and attach GDB to the running program." @echo "" + @echo " standalone BSP=mee STANDALONE_DEST=/path/to/desired/location" + @echo " [PROGRAM=$(PROGRAM) BOARD=$(BOARD)]:" + @echo " Export a program for a single target into a standalone" + @echo " project directory at STANDALONE_DEST." + @echo "" @echo " For more information, read the accompanying README.md" .PHONY: clean diff --git a/README.md b/README.md index f900277..4ade87c 100644 --- a/README.md +++ b/README.md @@ -235,6 +235,19 @@ make BSP=mee [PROGRAM=hello] [BOARD=sifive-hifive1] debug make BSP=mee [PROGRAM=hello] [BOARD=sifive-hifive1] clean ``` +#### Create a Standalone Project #### + +You can export a program to a standalone project directory using the `standalone` +target. The resulting project will be locked to a specific target `BOARD`. Note +that this functionality is only supported for Freedom Metal programs, not the +Legacy Freedom E SDK. + +`STANDALONE_DEST` is a required argument to provide the desired project location. + +``` +make BSP=mee [PROGRAM=hello] [BOARD=sifive-hifive1] STANDALONE_DEST=/path/to/desired/location standalone +``` + Run `make help` for more commands. ### Benchmarking ### -- cgit v1.2.1-18-gbd029