Update README
authorJerry Jacobs <xor-gate@users.noreply.github.com>
Tue, 17 May 2016 18:00:06 +0000 (20:00 +0200)
committerJerry Jacobs <xor-gate@users.noreply.github.com>
Tue, 17 May 2016 18:00:06 +0000 (20:00 +0200)
Add Contributing and versioning to README

README

diff --git a/README b/README
index f6ac729bc020a3054e9805ddaa86a6dd4e682bcf..b7fbf12cd0c8e2fc2597f30e543ea00857be4d9e 100644 (file)
--- a/README
+++ b/README
@@ -24,7 +24,7 @@ Two different transport layers are used:
 
 * `pkg-config`
 * `intltool`
-* `cmake` or (`autoconf` && `automake && `autogen`)
+* `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
 
@@ -168,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.
@@ -237,6 +236,12 @@ STLink v2-1 (as found on the Nucleo boards), known working targets:
 
 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)