Update README

[fw/stlink] / README

diff --git a/README b/README
index da7fafa3237a17729d64aaa25767aec18b7741e5..fc2231854034e3a40582c336f59da8d65fd49477 100644 (file)
--- a/README
+++ b/README
@@ -19,8 +19,14 @@ Two different transport layers are used:
 
 ## Common requirements
 
+* Debian based distros (debian, ubuntu)
+  * `build-essential`
+
 * `pkg-config`
+* `intltool`
+* `cmake` or (`autoconf` && `automake` && `autogen`)
 * `libusb-1.0` (plus development headers for building, on debian based distros `libusb-1.0.0-dev` package)
+* (optional) for `stlink-gui` we need libgtk-3-dev
 
 ## For STLINKv1
 
@@ -48,7 +54,7 @@ following steps will build the project for you.
 
 ```
 $ ./autogen.sh
-$ ./configure
+$ ./configure --with-gtk-gui
 $ make
 ```
 
@@ -162,7 +168,6 @@ If you would link your executable to 0x08000000 and then do
 (gdb) load firmware.elf
 then it would be written to the memory.
 
-
 ## FAQ
 
 Q: My breakpoints do not work at all or only work once.
@@ -205,7 +210,7 @@ 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)
 * STM32F103VC, STM32F107RC, STM32L151RB, STM32F205RE and STM32F405RE on custom boards
-  (https://github.com/UweBonnes/wiki_fuer_alex/layout/usps...)
+  from [UweBonnes/wiki_fuer_alex](https://github.com/UweBonnes/wiki_fuer_alex/tree/master/layout)
 * STM32F103VET6 (HY-STM32 board)
 * STM32F105RCT6 (DecaWave EVB1000 board)
 * STM32F303xx (STM32F3 Discovery board)
@@ -230,3 +235,28 @@ STLink v2-1 (as found on the Nucleo boards), known working targets:
 * STM32L053R8 (STM32 Nucleo-L053R8 board)
 
 Please report any and all known working combinations so I can update this!
+
+## Known bugs
+
+### Sometimes flashing only works after a mass erase
+
+There is seen a problem sometimes where a flash loader run error occurs and is resolved after mass-erase
+of the flash:
+
+```
+2015-12-09T22:01:57 INFO src/stlink-common.c: Successfully loaded flash loader in sram
+2015-12-09T22:02:18 ERROR src/stlink-common.c: flash loader run error
+2015-12-09T22:02:18 ERROR src/stlink-common.c: run_flash_loader(0x8000000) failed! == -1
+```
+
+Issue(s): [#356](https://github.com/texane/stlink/issues/356)
+
+## Contributing and versioning
+
+* The semantic versioning scheme is used. Read more at [semver.org](http://semver.org)
+* When creating a pull request, please open first a issue for discussion of new features
+* TODO: Enforcement of coding style (linux codestyle + checkpatch)
+
+## License
+
+The stlink library and tools are licensed under the [BSD license](LICENSE)