Merge pull request #189 from dandev37/master
[fw/stlink] / README
diff --git a/README b/README
index bb06f60a96bf236dd3b3364271d6034d7b3639e1..01751a7cf357a0807e1e50975c0e5f56109b3ad8 100644 (file)
--- a/README
+++ b/README
@@ -35,13 +35,25 @@ IF YOU HAVE AN STLINKv2
 
 You're ready to go :)
 
-To run the gdb server, do (you do not need sudo if you have set up
-permissions correctly):
-$ make && [sudo] ./gdbserver/st-util 
+COMPILING
+~~~~~~~~~
+This project was converted to Autotools by a well meaning individual. The
+following steps will build the project for you.
+
+$ ./autogen.sh
+$ ./configure
+$ make
+
+USING THE GDBSERVER
+~~~~~~~~~~~~~~~~~~~
+To run the gdb server: (you do not need sudo if you have set up
+permissions correctly)
+
+$ make && [sudo] ./st-util
 
 There are a few options:
 
-./gdbserver/st-util - usage:
+./st-util - usage:
 
   -h, --help        Print this help
   -vXX, --verbose=XX    specify a specific verbosity level (0..99)
@@ -52,8 +64,21 @@ There are a few options:
   -p 4242, --listen_port=1234
             Set the gdb server listen port. (default port: 4242)
 
-Then, in gdb: (remember, you need to run an _ARM_ gdb, not an x86 gdb)
-(gdb) target remote :4242
+Then, in your project directory, someting like this...
+(remember, you need to run an _ARM_ gdb, not an x86 gdb)
+
+$ arm-none-eabi-gdb fancyblink.elf
+...
+(gdb) tar extended-remote :4242
+...
+(gdb) load
+Loading section .text, size 0x458 lma 0x8000000
+Loading section .data, size 0x8 lma 0x8000458
+Start address 0x80001c1, load size 1120
+Transfer rate: 1 KB/sec, 560 bytes/write.
+(gdb)
+...
+(gdb) continue
 
 Have fun!
 
@@ -138,9 +163,14 @@ STLink v2 (as found on the 32L and F4 Discovery boards)
 Known Working Targets:
 * STM32F100xx (Medium Density VL, as on the 32VL Discovery board)
 * STM32L1xx (STM32L Discovery board)
-* STM32F107RC, STM32L151RB, STM32F205RE and  STM32F405RE  on a custom boards 
+* STM32F103VC, STM32F107RC, STM32L151RB, STM32F205RE and STM32F405RE on custom boards
   (https://github.com/UweBonnes/wiki_fuer_alex/layout/usps...)
+* STM32F303xx (STM32F3 Discovery board)
 * STM32F407xx (STM32F4 Discovery board)
+* STM32F429I-DISCO (STM32F4 Discovery board with LCD)
+* STM32F439VIT6 (discovery board reseated CPU)
+* STM32L151CB (custom board)
+* STM32L152RB (STM32L-Discovery board, custom board)
 
 Please report any and all known working combinations so I can update this!