Merge pull request #48 from sifive/readme_edits

Update README.md

2 files changed, 30 insertions, 9 deletions

diff --git a/Makefile b/Makefile
index bd715d2..22a5832 100644
--- a/Makefile
+++ b/Makefile
@@ -15,26 +15,30 @@ 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 ""
 	@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 "    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 6cfb3ce..523e754 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,22 @@ 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:
+
+```
+make uninstall
+make tools
+```
 
 ### Benchmarking ###