From 8bd2184f1b2c44dffaa3221898a32e8540769a27 Mon Sep 17 00:00:00 2001 From: Megan Wachs Date: Thu, 26 Jan 2017 16:04:32 -0800 Subject: Update README.md Add details about how to keep the repo up to date --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 6cfb3ce..0ab0b56 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,23 @@ To see additional options: cd freedom-e-sdk make help ``` +### Updating your SDK ### + +If you'd like to update your SDK to the latest version: + +``` +cd freedom-e-sdk +git pull origin master +git submodule update --init --recursive +``` + +If you would like to recompile the entire toolchain after performing the above: + +``` +rm -rf toolchain +rm -rf work +make tools +``` ### Benchmarking ### -- cgit v1.2.3 From b03acee657964f3c0268645b76ba8c3a3163c3fa Mon Sep 17 00:00:00 2001 From: Megan Wachs Date: Thu, 2 Feb 2017 09:09:35 -0800 Subject: help: Re-organized the Makefile help, and updated the README to use the already existing 'uninstall' target to remove and reinstall tools. --- Makefile | 19 ++++++++++++------- README.md | 3 +-- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index bd715d2..c995728 100644 --- a/Makefile +++ b/Makefile @@ -17,24 +17,28 @@ help : @echo " tools:" @echo " Install compilation & debugging tools" @echo "" + @echo " uninstall:" + @echo " Uninstall the compilation & debugging tools" + @echo "" @echo " software [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" @echo " Build a software program to load with the" @echo " debugger." @echo "" - @echo " run_debug [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" - @echo " Launch OpenOCD & GDB to load or debug " - @echo " running programs." - @echo "" @echo " upload [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" @echo " Launch OpenOCD to flash your program to the" @echo " on-board Flash" @echo "" + @echo " run_debug [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" + @echo " Launch OpenOCD & GDB to load or debug " + @echo " running programs. Does not allow Ctrl-C to halt running programs." + @echo "" @echo " run_openocd [BOARD=$(DEFAULT_BOARD)]:" @echo " run_gdb [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" - @echo " Launch OpenOCD or GDB seperately" + @echo " Launch OpenOCD or GDB seperately. Allows Ctrl-C to halt running" + @echo " programs." @echo "" @echo " dasm [PROGRAM=$(DEFAULT_BOARD)]:" - @echo " Generates the dissassembly output of objdump -D to stdout." + @echo " Generates the dissassembly output of 'objdump -D' to stdout." @echo "" @echo " For more information, visit dev.sifive.com" @@ -81,7 +85,8 @@ $(openocd_dest)/bin/openocd: $(openocd_srcdir) .PHONY: uninstall uninstall: - rm -rf -- $(toolchain_dest) + rm -rf $(wrkdir) + rm -rf $(toolchain_dest) ############################################################# # This Section is for Software Compilation diff --git a/README.md b/README.md index 0ab0b56..523e754 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,7 @@ git submodule update --init --recursive If you would like to recompile the entire toolchain after performing the above: ``` -rm -rf toolchain -rm -rf work +make uninstall make tools ``` -- cgit v1.2.3 From 68a2e21474b66c8ef929e0aa36bf7f42f85ea4e2 Mon Sep 17 00:00:00 2001 From: Megan Wachs Date: Thu, 2 Feb 2017 09:13:59 -0800 Subject: help: use punctuation consistently --- Makefile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index c995728..22a5832 100644 --- a/Makefile +++ b/Makefile @@ -15,10 +15,10 @@ help : @echo " Makefile targets:" @echo "" @echo " tools:" - @echo " Install compilation & debugging tools" + @echo " Install compilation & debugging tools." @echo "" @echo " uninstall:" - @echo " Uninstall the compilation & debugging tools" + @echo " Uninstall the compilation & debugging tools." @echo "" @echo " software [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" @echo " Build a software program to load with the" @@ -26,7 +26,7 @@ help : @echo "" @echo " upload [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" @echo " Launch OpenOCD to flash your program to the" - @echo " on-board Flash" + @echo " on-board Flash." @echo "" @echo " run_debug [PROGRAM=$(DEFAULT_PROGRAM) BOARD=$(DEFAULT_BOARD)]:" @echo " Launch OpenOCD & GDB to load or debug " -- cgit v1.2.3