aboutsummaryrefslogtreecommitdiffstats
path: root/Makefile
diff options
context:
space:
mode:
Diffstat (limited to 'Makefile')
-rw-r--r--Makefile52
1 files changed, 26 insertions, 26 deletions
diff --git a/Makefile b/Makefile
index 313cf94..833799b 100644
--- a/Makefile
+++ b/Makefile
@@ -130,32 +130,32 @@ mrproper: clean
help:
@echo ""
- @echo " libmaple Makefile help"
- @echo " ----------------------"
- @echo " "
- @echo " Programming targets:"
- @echo " sketch: Compile for BOARD to MEMORY_TARGET (default)."
- @echo " install: Compile and upload code over USB, using Maple bootloader"
- @echo " "
- @echo " You *must* set BOARD if not compiling for Maple (e.g."
- @echo " use BOARD=maple_mini for mini, etc.), and MEMORY_TARGET"
- @echo " if not compiling to Flash."
- @echo " "
- @echo " Valid BOARDs:"
- @echo " maple, maple_mini, maple_RET6, maple_native"
- @echo " "
- @echo " Valid MEMORY_TARGETs (default=flash):"
- @echo " ram: Compile sketch code to ram"
- @echo " flash: Compile sketch code to flash"
- @echo " jtag: Compile sketch code for jtag; overwrites bootloader"
- @echo " "
- @echo " Other targets:"
- @echo " debug: Start OpenOCD gdb server on port 3333, telnet on port 4444"
- @echo " clean: Remove all build and object files"
- @echo " help: Show this message"
- @echo " doxygen: Build Doxygen HTML and XML documentation"
- @echo " mrproper: Remove all generated files"
- @echo " "
+ @echo "Basic usage (BOARD defaults to maple):"
+ @echo " $$ cp your-main.cpp main.cpp"
+ @echo " $$ make BOARD=your_board"
+ @echo " $$ make BOARD=your_board install"
+ @echo ""
+ @echo "Important targets:"
+ @echo " sketch: Compile for BOARD to MEMORY_TARGET (default)."
+ @echo " install: Compile and upload over USB using Maple bootloader"
+ @echo ""
+ @echo "You *must* set BOARD if not compiling for Maple (e.g."
+ @echo "use BOARD=maple_mini for mini, etc.), and MEMORY_TARGET"
+ @echo "if not compiling to Flash. Run \`$$ make list-boards' for"
+ @echo "a list of all boards."
+ @echo ""
+ @echo "Valid MEMORY_TARGETs (default=flash):"
+ @echo " ram: Compile to RAM (doesn't touch Flash)"
+ @echo " flash: Compile to Flash (for Maple bootloader)"
+ @echo " jtag: Compile for JTAG/SWD upload (overwrites bootloader)"
+ @echo ""
+ @echo "Other targets:"
+ @echo " debug: Start OpenOCD gdb server on port 3333, telnet on port 4444"
+ @echo " clean: Remove all build and object files"
+ @echo " help: Show this message"
+ @echo " doxygen: Build Doxygen HTML and XML documentation"
+ @echo " mrproper: Remove all generated files"
+ @echo ""
debug:
$(OPENOCD_WRAPPER) debug