Update README

[fw/stlink] / README

diff --git a/README b/README
index e5a51cf5e155c6401b552dc579ea410fdbe83198..8fc282bc5dd427d42133b4146c2a4f0b051e94a8 100644 (file)
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
-STMicroelectronics Stlink Tools
-===============================
+Open source version of the STMicroelectronics Stlink Tools
+==========================================================

 
 

-[![Build Status](https://travis-ci.org/texane/stlink.svg?branch=travis)](https://travis-ci.org/texane/stlink)
+[![Build Status](https://travis-ci.org/texane/stlink.svg?branch=master)](https://travis-ci.org/texane/stlink)

 
 ## HOWTO
 
 
 ## HOWTO
 


@@ -19,9 +19,14 @@ Two different transport layers are used:
 
 ## Common requirements
 
 
 ## Common requirements
 

-. libusb-1.0  (You probably already have this, but you'll need the
-development version to compile)
-. pkg-config
+* 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
 
 
 ## For STLINKv1
 


@@ -31,10 +36,10 @@ is tell your operating system to completely ignore it.
 Options (do one of these before you plug it in)
 
 * `modprobe -r usb-storage && modprobe usb-storage quirks=483:3744:i`
 Options (do one of these before you plug it in)
 
 * `modprobe -r usb-storage && modprobe usb-storage quirks=483:3744:i`

-* or *)1. add "options usb-storage quirks=483:3744:i" to /etc/modprobe.conf
-*   *)2. modprobe -r usb-storage && modprobe usb-storage
-* or *)1. cp stlink_v1.modprobe.conf /etc/modprobe.d
-*   *)2. modprobe -r usb-storage && modprobe usb-storage
+* or 1. `echo "options usb-storage quirks=483:3744:i" >> /etc/modprobe.conf`
+*    2. `modprobe -r usb-storage && modprobe usb-storage`
+* or 1. `cp stlink_v1.modprobe.conf /etc/modprobe.d`
+*    2. `modprobe -r usb-storage && modprobe usb-storage`

 
 ## For STLINKv2
 
 
 ## For STLINKv2
 


@@ -49,7 +54,7 @@ following steps will build the project for you.
 
 ```
 $ ./autogen.sh
 
 ```
 $ ./autogen.sh

-$ ./configure
+$ ./configure --with-gtk-gui

 $ make
 ```
 
 $ make
 ```
 


@@ -163,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.
 
 (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.
 ## FAQ
 
 Q: My breakpoints do not work at all or only work once.


@@ -206,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
 * 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)
 * STM32F103VET6 (HY-STM32 board)
 * STM32F105RCT6 (DecaWave EVB1000 board)
 * STM32F303xx (STM32F3 Discovery board)


@@ -231,3 +235,13 @@ 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!
 * STM32L053R8 (STM32 Nucleo-L053R8 board)
 
 Please report any and all known working combinations so I can update this!

+
+## 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)