[doc] Updated package requirements

- Added info on GTK3 libs & versioning - Updated compiling instructions for macOS
stlink-org · Apr 17, 2020 · f489145 · f489145
1 parent e98c7d4
commit f489145
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 39 deletions.
diff --git a/doc/compiling.md b/doc/compiling.md
@@ -58,6 +58,7 @@ It can be copied from here: `build\3rdparty\libusb-1.0.21\MS32\dll\libusb-1.0.dl
 
 Install the following packages from your package repository:
 
+* `git`
 * `gcc` or `clang` or `mingw32-gcc` or `mingw64-gcc` (C-compiler; very likely gcc is already present)
 * `build-essential` (on Debian based distros (debian, ubuntu))
 * `cmake` (3.4.2 or later, use the latest version available from the repository)
@@ -162,22 +163,26 @@ Choose on of the following options _before_ connecting the device to your comput
 ## macOS
 ### Common requirements
 
-The best way is to install a package manager for open source software,
+The best and recommended way is to install a package manager for open source software,
 either [homebrew](https://brew.sh) or [MacPorts](https://www.macports.org/).
 
 Then install the following dependencies from the package repository:
 
 * `git`
+* `gcc` or `llvm` (for clang) (C-compiler)
 * `cmake`
 * `pkg-config`
 * `libusb`
+* `gtk+3` or `gtk3` (_optional_, needed for `stlink-gui`)
 
 To do this with only one simple command, type:
 
-* for homebrew: `sudo brew install git cmake libusb` or
-* for MacPorts:`sudo port install git cmake libusb`
-
-Additionally we recommend to install Xcode which delivers the necessary C-compiler toolchain Clang (LLVM).
+* for homebrew:
+    - with gcc:   `sudo brew install git gcc cmake libusb gtk+3` or
+    - with clang: `sudo brew install git llvm cmake libusb gtk+3` or
+* for MacPorts:
+    - with gcc:    `sudo port install git llvm-9.0 cmake libusb gtk3` or
+    - with clang:  `sudo port install git gcc9 cmake libusb gtk3`
 
 
 ### Installation

diff --git a/doc/version_support.md b/doc/version_support.md
@@ -1,5 +1,5 @@
 
-Sources: [pkgs.org - libusb](https://pkgs.org/search/?q=libusb) & [pkgs.org - cmake](https://pkgs.org/search/?q=cmake) (as of Mar 2020):
+_Source:_ pkgs.org - [libusb](https://pkgs.org/search/?q=libusb); [cmake](https://pkgs.org/search/?q=cmake); [gtk](https://pkgs.org/search/?q=gtk) (as of Apr 2020)
 
 
 ## Supported Operating Systems
@@ -16,55 +16,55 @@ Thus no user interaction regarding libusb is necessary.
 
 ### Apple macOS
 
-| Package Repository | libusb<br />version | cmake<br />version | gtk<br />version | Supported macOS versions |
+| Package Repository | libusb<br />version | cmake<br />version | gtk-3<br />version | Supported macOS versions |
 | --- | --- | --- | --- | --- |
 | homebrew | 1.0.23 | 3.17.0 | 3.24.18<br />gtk+3 | 10.12 (Sierra)- 10.15 (Catalina) |
-| MacPorts | 1.0.23 | 3.17.0 | _N/A_ | 10.6 (Snow Leopard) - 10.15 (Catalina) |
+| MacPorts | 1.0.23 | 3.17.0 | 3.24.18<br />gtk3 | 10.6 (Snow Leopard) - 10.15 (Catalina) |
 
 
 ### Linux-/Unix-based:
 
-| Operating System | libusb<br />version | cmake<br />version | gtk<br />version | Notes |
+| Operating System | libusb<br />version | cmake<br />version | gtk-3<br />version | Notes |
 | --- | --- | --- | --- | --- |
-| Alpine Edge | 1.0.23 | 3.17.0 | |
-| ALT Linux Sisyphus | 1.0.23 | 3.17.0 | |
-| Arch Linux | 1.0.23 | 3.17.0 | |
-| Fedora Rawhide | 1.0.23 | 3.17.0 | | named `libusbx`, but `libusb`-codebase is used |
-| KaOS | 1.0.23 | 3.17.0 | |
-| OpenMandriva Cooker | 1.0.23 | 3.17.0 | |
-| PCLinuxOS | 1.0.23 | 3.17.0 | | named `lib64usb1.0_0-1.0.23-1pclos2019.x86_64` |
-| Slackware Current | 1.0.23 | 3.17.0 | |
-| Solus | 1.0.23 | 3.16.5 | |
+| Alpine Edge | 1.0.23 | 3.17.0 | 3.24.18<br />gtk+3.0-dev | |
+| ALT Linux Sisyphus | 1.0.23 | 3.17.0 | 3.24.18<br />libgtk+3-devel | |
+| Arch Linux | 1.0.23 | 3.17.0 | 3.24.18<br />gtk3 | |
+| Fedora Rawhide | 1.0.23 | 3.17.0 | 3.24.18<br />gtk3-devel | | named `libusbx`, but<br />`libusb`-codebase is used |
+| KaOS | 1.0.23 | 3.17.0 | 3.24.18<br />gtk3 | |
+| OpenMandriva Cooker | 1.0.23 | 3.17.0 | 3.24.18<br />libgtk+3.0-devel<br />lib64gtk+3.0-devel | |
+| PCLinuxOS | 1.0.23<br />lib64usb1.0 | 3.17.0 | 3.24.18<br />lib64gtk+3.0-devel | |
+| Slackware Current | 1.0.23 | 3.17.0 | 3.24.18<br />gtk+3 | |
+| Solus | 1.0.23 | 3.16.5 | 3.24.16<br />libgtk-3-devel | |
 | Debian Sid | 1.0.23 | 3.16.3 | 3.24.18<br />libgtk-3-dev | |
-| OpenMandriva Lx 4.1 | 1.0.23 | 3.16.3 | |
+| OpenMandriva Lx 4.1 | 1.0.23 | 3.16.3 | 3.24.13<br />libgtk+3.0-devel<br />lib64gtk+3.0-devel | |
 | Ubuntu 20.04 LTS (Focal Fossa) | 1.0.23 | 3.16.3 | 3.24.17<br />libgtk-3-dev | |
-| openSUSE Tumbleweed | 1.0.23 | 3.16.2 | |
-| Alpine 3.11 | 1.0.23 | 3.15.5 | |
+| openSUSE Tumbleweed | 1.0.23 | 3.16.2 | 3.24.16<br />gtk3-devel | |
+| Alpine 3.11 | 1.0.23 | 3.15.5 | 3.24.13<br />gtk+3.0-dev | |
 | Ubuntu 19.10 (Eoan Ermine) | 1.0.23 | 3.13.4 | 3.24.12<br />libgtk-3-dev | |
-| Mageia Cauldron | 1.0.22 | 3.17.0 | |
-| NetBSD 9.0 | 1.0.22 | 3.16.1 | |
-| NetBSD 8.1 | 1.0.22 | 3.16.1 | |
-| NetBSD 7.2 | 1.0.22 | 3.16.1 | |
-| Alpine 3.10 | 1.0.22 | 3.14.5 | |
-| Fedora 31 | 1.0.22 | 3.14.5 | | named `libusbx`, but `libusb`-codebase is used |
-| Mageia 7.1 | 1.0.22 | 3.14.3 | |
-| Fedora 30 | 1.0.22 | 3.14.2 | | named `libusbx`, but `libusb`-codebase is used |
+| Mageia Cauldron | 1.0.22 | 3.17.0 | 3.24.18<br />libgtk+3.0-devel<br />lib64gtk+3.0-devel | |
+| NetBSD 9.0 | 1.0.22 | 3.16.1 | 3.24.12<br />gtk+3 | |
+| NetBSD 8.1 | 1.0.22 | 3.16.1 | 3.24.12<br />gtk+3 | |
+| NetBSD 7.2 | 1.0.22 | 3.16.1 | _N/A_ | |
+| Alpine 3.10 | 1.0.22 | 3.14.5 | 3.24.8<br />gtk+3.0-dev | |
+| Fedora 31 | 1.0.22 | 3.14.5 | 3.24.12<br />gtk3-devel | named `libusbx`, but<br />`libusb`-codebase is used |
+| Mageia 7.1 | 1.0.22 | 3.14.3 | 3.24.8<br />libgtk+3.0-devel<br />lib64gtk+3.0-devel | |
+| Fedora 30 | 1.0.22 | 3.14.2 | 3.24.8<br />gtk3-devel | named `libusbx`, but<br />`libusb`-codebase is used |
 | Debian 10 (Buster) | 1.0.22 | 3.13.4 | 3.24.5<br />libgtk-3-dev | |
-| Alpine 3.9 | 1.0.22 | 3.13.0 | |
-| CentOS 8 | 1.0.22 | 3.11.4 | | named `libusbx`, but `libusb`-codebase is used |
-| openSUSE Leap 15.2 | 1.0.21 | 3.15.5 | |
-| openSUSE Leap 15.1 | 1.0.21 | 3.10.2 | |
+| Alpine 3.9 | 1.0.22 | 3.13.0 | 3.24.1<br />gtk+3.0-dev | |
+| CentOS 8 | 1.0.22 | 3.11.4 | 3.22.30<br />gtk3-devel | named `libusbx`, but<br />`libusb`-codebase is used |
+| openSUSE Leap 15.2 | 1.0.21 | 3.15.5 | 3.24.14<br />gtk3-devel | |
+| openSUSE Leap 15.1 | 1.0.21 | 3.10.2 | 3.22.30<br />gtk3-devel | |
 | Ubuntu 18.04 LTS (Bionic Beaver) | 1.0.21 | 3.10.2 | 3.22.30<br />libgtk-3-dev | |
 | Debian 9 (Stretch) | 1.0.21 | 3.7.2 | 3.22.11<br />libgtk-3-dev | |
-| Slackware 14.2 | **1.0.20** | 3.5.2 | |
+| Slackware 14.2 | **1.0.20** | 3.5.2 | 3.18.9<br />gtk+3 | |
 | Ubuntu 16.04 LTS (Xenial Xerus) | **1.0.20** | 3.5.1 | 3.18.9<br />libgtk-3-dev | |
-| OpenMandriva Lx 3.0 | **1.0.20** | **3.4.2** | |
-| FreeBSD 13 | **1.0.16** - 1.0.18 | 3.15.5 | | linux_libusb-13.0r358841 (integrated) |
-| FreeBSD 12 | **1.0.16** - 1.0.18 | 3.15.5 | | linux_libusb-11.0r261448_4 (integrated) |
-| FreeBSD 11 | **1.0.16** - 1.0.18 | 3.15.5 | | linux_libusb-11.0r261448_4 (integrated) |
+| OpenMandriva Lx 3.0 | **1.0.20** | **3.4.2** | 3.18.9<br />libgtk+3.0-devel<br />lib64gtk+3.0-devel | |
+| FreeBSD 13 | **1.0.16** - 1.0.18 | 3.15.5 | 3.24.10<br />gtk3 | linux_libusb-13.0r358841<br />(integrated) |
+| FreeBSD 12 | **1.0.16** - 1.0.18 | 3.15.5 | 3.24.10<br />gtk3 | linux_libusb-11.0r261448_4<br />(integrated) |
+| FreeBSD 11 | **1.0.16** - 1.0.18 | 3.15.5 | 3.24.10<br />gtk3 | linux_libusb-11.0r261448_4<br />(integrated) |
 
 
-## Unsupported Operating Systems as of Release 1.6.1 (2020)
+## Unsupported Operating Systems (as of Release v1.6.1)
 
 | Operating System | libusb<br />version | cmake<br />version | End of OS-Support | Notes |
 | --- | --- | --- | --- | --- |