diff --git a/README.md b/README.md index b2495840d..f52a9b3e4 100644 --- a/README.md +++ b/README.md @@ -23,8 +23,7 @@ are licensed under the **General Public License (GPL v2+)**. ## Introduction STLink is an open source toolset to program and debug STM32 devices and boards manufactured by STMicroelectronics. -It supports several so called STLINK programmer boards (and clones thereof) which use a microcontroller chip -to translate commands from USB to JTAG/SWD. There are four generations available on the market: +It supports several so called STLINK programmer boards (and clones thereof) which use a microcontroller chip to translate commands from USB to JTAG/SWD. There are four generations available on the market which are _all_ supported by this toolset: * **STLINK/v1** _(obsolete as of 21-11-2019)_ - transport layer: SCSI passthru commands over USB @@ -59,7 +58,7 @@ Supported operating systems are listed in [version_support.md](doc/version_suppo ## Tutorial & HOWTO -Our [tutorial.md](doc/tutorial.md) may help you along with some advanced tasks and additional info. +Our [tutorial](doc/tutorial.md) may help you along with some advanced tasks and additional info. ## Installation diff --git a/contributors.txt b/contributors.txt index 32c8e58e3..8811da855 100644 --- a/contributors.txt +++ b/contributors.txt @@ -37,6 +37,7 @@ Ethan Zonca Fabien Chouteau Florian Hars Friedrich Beckmann +Gabriel Górski [Glaeqen] Geoffrey Brown George Talusan [gtalusan] Georg von Zengen @@ -60,6 +61,7 @@ Jerome Lambourg Jim Paris Jiří Netolický Jerry Nosky [jnosky] +Jochen Wilhelmy [Jochen0x90h] Johannes Taelman Jonas Danielsson Jonas Norling @@ -68,6 +70,7 @@ Karl Palsson [karlp] Kevlar Harness Kyle Manna Lari Lehtomäki +Lutz Freitag [nerdmaennchen] Martin Nowak Matteo Collina Max Chen @@ -76,6 +79,7 @@ Maxime Vincent Michael Pratt [prattmic] Michael Sparmann Mike Szczys +Miklós Márton [martonmiklos] Magnus Lundin [mlu] mux Ned Konz @@ -89,6 +93,7 @@ orangeudav Pavel Kirienko Pekka Nikander Pete Nelson +Peter Torelli [petertorelli] Peter Zotov Petteri Aimonen Piotr Haber @@ -99,6 +104,7 @@ Rob Spanton Rytis Karpuska Sean Simmons Sergey Alirzaev +Simon Derr [sderr] Simon Wright Stany Marcel Stefan Misik diff --git a/doc/app-example/CMakeLists.txt b/doc/app-example/CMakeLists.txt index a7697720c..5f71a5d4f 100644 --- a/doc/app-example/CMakeLists.txt +++ b/doc/app-example/CMakeLists.txt @@ -6,17 +6,18 @@ cmake_minimum_required(VERSION 3.4.2) project(st-hello) set(PROJECT_VERSION 0.1) + set(SRCS main.c) +include_directories(${STLINK_INCLUDE_DIRS}) + find_package(PkgConfig) pkg_check_modules(STLINK REQUIRED stlink) set(CMAKE_C_FLAGS " ${STLINK_CFLAGS_OTHER} -Wall -Werror") -include_directories(${STLINK_INCLUDE_DIRS}) - add_executable(${PROJECT_NAME} ${SRCS}) target_link_libraries(${PROJECT_NAME} ${STLINK_LIBRARIES}) -install(TARGETS ${PROJECT_NAME} DESTINATION bin) +install(TARGETS ${PROJECT_NAME} DESTINATION ${CMAKE_INSTALL_BINDIR}) diff --git a/doc/app-example/README.md b/doc/app-example/README.md index 683056171..f3a0bf9bb 100644 --- a/doc/app-example/README.md +++ b/doc/app-example/README.md @@ -1,2 +1,2 @@ This is a simple standalone application example that uses libstlink. -You can use this as a boilerplate for your own app development +It can be used as a boilerplate for app development. diff --git a/doc/app-example/main.c b/doc/app-example/main.c index 12621434a..b8e64b259 100644 --- a/doc/app-example/main.c +++ b/doc/app-example/main.c @@ -2,8 +2,7 @@ #include #include -static stlink_t *stlink_open_first(void) -{ +static stlink_t *stlink_open_first(void) { stlink_t* sl = NULL; sl = stlink_v1_open(0, 1); if (sl == NULL) @@ -13,8 +12,7 @@ static stlink_t *stlink_open_first(void) } -int main() -{ +int main() { stlink_t* sl = NULL; sl = stlink_open_first(); @@ -25,5 +23,6 @@ int main() fprintf(stderr, "STlink device opened, that's cool!\n"); stlink_close(sl); + return 0; } diff --git a/doc/devices_boards.md b/doc/devices_boards.md index 00acdd2cf..8291f7532 100644 --- a/doc/devices_boards.md +++ b/doc/devices_boards.md @@ -53,7 +53,7 @@ Tested boards [incl. STLink programmers]: | 0x430 | XL-Density | xF XG | | F101 | | F103 | | Tested boards [incl. STLink programmers]: -* 32VL-Discovery (STM32F100RBT6) with STLink-v1 [v1, v2] +* STM32VL-Discovery (STM32F100RBT6) with STLink-v1 [v1, v2] * STM32F103-Bluepill: C8Tx & R8xx [v2] * Nucleo-F103RB [v2-1] * HY-STM32 (STM32F103VETx) [v1, v2] diff --git a/doc/release.md b/doc/release.md index 4b536d95a..b44183b80 100644 --- a/doc/release.md +++ b/doc/release.md @@ -3,7 +3,7 @@ Release This document describes the necessary steps for developers to create a release: -1. Update `CHANGELOG.md` and `cmake/packaging/deb/changelog` +1. Update `CHANGELOG.md` 2. Update `.version` with semantic version: `x.x.x` 3. Update `README.md` with semantic version `x.x.x` in commits badge 4. Create and push git tag and commits `git tag x.x.x` diff --git a/doc/version_support.md b/doc/version_support.md index f889fbc32..4d1f724f7 100644 --- a/doc/version_support.md +++ b/doc/version_support.md @@ -21,6 +21,8 @@ Thus no user interaction regarding libusb is necessary. | homebrew | 1.0.23 | 3.17.0 | 3.24.18
gtk+3 | 10.12 (Sierra)- 10.15 (Catalina) | | MacPorts | 1.0.23 | 3.17.0 | 3.24.18
gtk3 | 10.6 (Snow Leopard) - 10.15 (Catalina) | +NOTE: In order to use a STLINK/v1 programmer on macOS, versions 10.13, 10.14 or 10.15 are required. + ### Linux-/Unix-based: diff --git a/run_clang_analyze.sh b/run_clang_analyze.sh index 8d5c5a988..fd1b78b55 100755 --- a/run_clang_analyze.sh +++ b/run_clang_analyze.sh @@ -1,6 +1,7 @@ #!/bin/bash -# Run this hacky script in project root directory to start -# clang static analysis. Adjust ccc-analyzer path if nesesary +# Run this hacky script in project root directory to start clang static analysis. +# Adjust ccc-analyzer path if necessary + CCC_ANALYZER=/usr/share/clang/scan-build-3.5/ccc-analyzer mkdir -p build-clang-analyze/reports cd build-clang-analyze