initial commit

README.md

@@ -1,3 +1,41 @@
-# alpine_wsjtx
+# WSJT-X for Alpine Linux
 
-WSJT-X for Alpine Linux
+This repo contains a modified `CMakeLists.txt` taken from K1JT's original repo and modified to run on Alpine Linux.
+
+## Why
+
+wsjt-x doesn't compile smoothly on Alpine Linux. The main reason is: it ships with a slightly outdated version
+of hamlib which contains a bug which makes it fail on Alpine. Furthermore, the URLs of the repositories in the
+original CMakeLists.txt is completely outdated.
+
+## Prerequisites
+
+you need to apk add the following packages:
+
+gfortran asciidoc asciidoctor cmake build-base qt5-qtmultimedia-dev qt5-qtserialport-dev qt5-qttools qt5-qttools-dev fftw-single-libs fftw-double-libs fftw-dev readline readline-dev libusb-dev portaudio-dev boost boost-dev eudev-dev
+
+## BUILD
+
+check out the repo, then create a build directory and call cmake like this
+
+```
+cmake -DCMAKE_INSTALL_PREFIX=/usr/local -D WSJTX_TAG=wsjtx-2.6.1 -D HAMLIB_TAG=Hamlib-4.5.5 ../wsjtx-2.6.1 .
+cmake --build . --target=source
+```
+
+that will create a file `wsjtx-2.6.1.tgz` which then needs to be build like this:
+
+```
+	    $ tar xzf wsjtx-2.6.1.tgz
+    $ mkdir build
+    $ cd build
+    $ cmake -DCMAKE_INSTALL_PREFIX=/usr/local -DWSJT_SKIP_MANPAGES=ON -DWSJT_GENERATE_DOCS=OFF ../wsjtx-2.3.0
+    $ cmake --build .
+    $ sudo cmake --build . --target install
+```
+
+This repo contains a copy of the original text documents, but no source code.
+
+Author of this patch is Torsten DL1THM, all credits of the WSJT-X code go to the original authors.
+
+License: GPLv3