Updated documentation

- Added note on windows binary installation - Contributors now listed in separate file (Closes #738) (Closes #795)
stlink-org · May 10, 2020 · 06c66ed · 06c66ed
1 parent 7bb34fc
commit 06c66ed
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 124 deletions.
diff --git a/README.md b/README.md
@@ -66,9 +66,10 @@ Our [tutorial.md](doc/tutorial.md may help you along with some advanced tasks an
 
 **Windows**:
 
-Please compile and install from source as described in our [compiling manual](doc/compiling.md#Windows).
+As of Release v1.6.1 stand-alone Windows binaries are made available (again) on the release page of the project.
+Please ensure to select the correct version for your system (i686 or x86_64). The archive file can be unzipped to any desired location as it does not contain any hardcoded paths. However we suggest to move the unzipped application folder to `C:\Program Files\` on 32-bit systems and to `C:\Program Files (x86)\` on 64-bit systems (the toolset is a 32-bit).
 
-Long awaited binaries will be available soon...
+Alternatively one may compile and install from source as described in our [compiling manual](doc/compiling.md#Windows).
 
 **macOS**:
 

diff --git a/cmake/packaging/cpack_config.cmake b/cmake/packaging/cpack_config.cmake
@@ -19,7 +19,7 @@ if (APPLE)
     set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${PROJECT_VERSION}-macosx-amd64")
     set(CPACK_INSTALL_PREFIX "")
 
-elseif (WIN32 AND NOT EXISTS "/etc/debian_version")                             # Windows
+elseif (WIN32 AND (NOT EXISTS "/etc/debian_version"))                           # Windows
     set(CPACK_GENERATOR "ZIP")
     set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${PROJECT_VERSION}-win32")
     set(CPACK_INSTALL_PREFIX "")
@@ -75,6 +75,8 @@ elseif (EXISTS "/etc/debian_version" AND NOT EXISTS WIN32) # Package-build is av
     # Slackware & Redhat (RPM)
     ###
 
+    set(CPACK_SET_DESTDIR "OFF")
+
     # CPACK_RPM_PACKAGE_SUMMARY          --> Default: CPACK_PACKAGE_DESCRIPTION_SUMMARY
     # CPACK_RPM_PACKAGE_NAME             --> Default: CPACK_PACKAGE_NAME
 
@@ -94,6 +96,9 @@ elseif (EXISTS "/etc/debian_version" AND NOT EXISTS WIN32) # Package-build is av
     # CPACK_RPM_PACKAGE_VENDOR           --> Default: CPACK_PACKAGE_VENDOR (as it is set)
     # CPACK_RPM_PACKAGE_URL              --> Default: CMAKE_PROJECT_HOMEPAGE_URL
     set(CPACK_RPM_PACKAGE_DESCRIPTION CPACK_DEBIAN_PACKAGE_DESCRIPTION)
+
+    ## Add CHANGELOG in rpm-specific format
+                                                                                ### TODO
 else ()
     # No package configuration on other platforms ...
 endif ()

diff --git a/cmake/packaging/deb/copyright b/cmake/packaging/deb/copyright
@@ -34,124 +34,4 @@ Copyright: 2011-2020 stlink-org
     Jerry Jacobs [xor-gate]
     [Nightwalker-87]
     .
-    Alexey Cherevatenko
-    Alexey Panarin
-    Anatoli Klassen [dev26th]
-    Andrea Mucignat
-    Andrew Andrianov [necromant]
-    Andrey Yurovsky
-    Andy Isaacson
-    Áron Radics
-    A. Sheaff
-    Björn Hauffe
-    Ihor Bobalo
-    Breton M. Saunders
-    Bruno Dal Bo
-    Burns Fisher
-    Cheng Guokai (Xim) [chenguokai]
-    Chris Dew
-    Chris Hiszpanski
-    Chris Li
-    Chris Samuelson
-    Christian Deussen [nullsub]
-    Christophe Levantis
-    Craig Lilley
-    Dan Dev
-    Dan Hepler
-    Daniel Campoverde [alx741]
-    Daniel O'Connor
-    Dave Flogeras
-    Dave Murphy [WinterMute]
-    Dave Vandervies [dj3vande]
-    Denis Fokin
-    Denis Osterland
-    Dmitry Bravikov [bravikov]
-    Efe Can İçöz
-    Ethan Zonca
-    Fabien Chouteau
-    Florian Hars
-    Friedrich Beckmann
-    Geoffrey Brown
-    George Talusan [gtalusan]
-    Georg von Zengen
-    Giuseppe Barba
-    Greg Alexander [galexander1]
-    Greg Meiste [meisteg]
-    Guillaume Revaillot [grevaillot]
-    Hakkavélin <hakkavelin@braudrist.lan>
-    Halt Hammerzeit
-    htk <htk@vdr.fritz.box>
-    Ian Griffiths
-    Jack Peel
-    Jakub Tyszkowski
-    Jan Sarenik
-    Jean-Luc Béchennec
-    Jean-Marie Lemetayer
-    Jeff Kent
-    Jeffrey Nelson
-    Jens Hoffmann
-    Jerome Lambourg
-    Jim Paris
-    Jiří Netolický
-    Jerry Nosky [jnosky]
-    Johannes Taelman
-    Jonas Danielsson
-    Jonas Norling
-    Josh Bialkowski
-    Karl Palsson [karlp]
-    Kevlar Harness
-    Kyle Manna
-    Lari Lehtomäki
-    Martin Nowak
-    Matteo Collina
-    Max Chen
-    Maxime Coquelin [mcoquelin-stm32]
-    Maxime Vincent
-    Michael Pratt [prattmic]
-    Michael Sparmann
-    Mike Szczys
-    Magnus Lundin [mlu]
-    mux <freelancer.c@gmail.com>
-    Ned Konz
-    Nic McDonald
-    Nicolas Schodet
-    Oleksiy Slyshyk [slyshykO]
-    Olivier Croquette
-    Olivier Gay
-    Onno Kortmann
-    orangeudav <orangeudav@gmail.com>
-    Pavel Kirienko
-    Pekka Nikander
-    Pete Nelson
-    Peter Zotov
-    Petteri Aimonen
-    Piotr Haber
-    Rene Hopf [rene-dev]
-    Robin Kreis
-    Roger Wolff [rewolff]
-    Rob Spanton
-    Rytis Karpuska
-    Sean Simmons
-    Sergey Alirzaev
-    Simon Wright
-    Stany Marcel
-    Stefan Misik
-    Sven Wegener
-    Joel Bodenmann [Tectu]
-    Tuomo Kaikkonen
-    Theodore A. Roth
-    Thomas Gärtner
-    Tobias Badertscher
-    Tom de Boer
-    Tristan Gingold
-    Uli Köhler
-    Uwe Bonnes [UweBonnes]
-    Vadim Kaushan
-    Vasiliy Glazov [Vascom]
-    Vegard Storheil Eriksen
-    Viacheslav Dobromyslov
-    Victor Mayoral Vilches
-    William Ransohoff [WRansohoff]
-    Wojciech A. Koszek
-    Woodrow Douglass
-    ... and others
+    and many others... A list of contributors can be found in "contributors.txt".
diff --git a/contributors.txt b/contributors.txt
@@ -0,0 +1,124 @@
+List of contributors to the stlink project:
+
+Alexey Cherevatenko
+Alexey Panarin
+Anatoli Klassen [dev26th]
+Andrea Mucignat
+Andrew Andrianov [necromant]
+Andrey Yurovsky
+Andy Isaacson
+Áron Radics
+A. Sheaff
+Björn Hauffe
+Ihor Bobalo
+Breton M. Saunders
+Bruno Dal Bo
+Burns Fisher
+Cheng Guokai (Xim) [chenguokai]
+Chris Dew
+Chris Hiszpanski
+Chris Li
+Chris Samuelson
+Christian Deussen [nullsub]
+Christophe Levantis
+Craig Lilley
+Dan Dev
+Dan Hepler
+Daniel Campoverde [alx741]
+Daniel O'Connor
+Dave Flogeras
+Dave Murphy [WinterMute]
+Dave Vandervies [dj3vande]
+Denis Fokin
+Denis Osterland
+Dmitry Bravikov [bravikov]
+Efe Can İçöz
+Ethan Zonca
+Fabien Chouteau
+Florian Hars
+Friedrich Beckmann
+Geoffrey Brown
+George Talusan [gtalusan]
+Georg von Zengen
+Giuseppe Barba
+Greg Alexander [galexander1]
+Greg Meiste [meisteg]
+Guillaume Revaillot [grevaillot]
+Hakkavélin <hakkavelin@braudrist.lan>
+Halt Hammerzeit
+htk <htk@vdr.fritz.box>
+Ian Griffiths
+Jack Peel
+Jakub Tyszkowski
+Jan Sarenik
+Jean-Luc Béchennec
+Jean-Marie Lemetayer
+Jeff Kent
+Jeffrey Nelson
+Jens Hoffmann
+Jerome Lambourg
+Jim Paris
+Jiří Netolický
+Jerry Nosky [jnosky]
+Johannes Taelman
+Jonas Danielsson
+Jonas Norling
+Josh Bialkowski
+Karl Palsson [karlp]
+Kevlar Harness
+Kyle Manna
+Lari Lehtomäki
+Martin Nowak
+Matteo Collina
+Max Chen
+Maxime Coquelin [mcoquelin-stm32]
+Maxime Vincent
+Michael Pratt [prattmic]
+Michael Sparmann
+Mike Szczys
+Magnus Lundin [mlu]
+mux <freelancer.c@gmail.com>
+Ned Konz
+Nic McDonald
+Nicolas Schodet
+Oleksiy Slyshyk [slyshykO]
+Olivier Croquette
+Olivier Gay
+Onno Kortmann
+orangeudav <orangeudav@gmail.com>
+Pavel Kirienko
+Pekka Nikander
+Pete Nelson
+Peter Zotov
+Petteri Aimonen
+Piotr Haber
+Rene Hopf [rene-dev]
+Robin Kreis
+Roger Wolff [rewolff]
+Rob Spanton
+Rytis Karpuska
+Sean Simmons
+Sergey Alirzaev
+Simon Wright
+Stany Marcel
+Stefan Misik
+Sven Wegener
+Joel Bodenmann [Tectu]
+Tuomo Kaikkonen
+Theodore A. Roth
+Thomas Gärtner
+Tobias Badertscher
+Tom de Boer
+Tristan Gingold
+Uli Köhler
+Uwe Bonnes [UweBonnes]
+Vadim Kaushan
+Vasiliy Glazov [Vascom]
+Vegard Storheil Eriksen
+Viacheslav Dobromyslov
+Victor Mayoral Vilches
+William Ransohoff [WRansohoff]
+Wojciech A. Koszek
+Woodrow Douglass
+
+... and others