Updated readme and install docs

This commit is contained in:
Jordan Sherer 2020-04-26 14:39:35 -04:00
parent abfe7dd833
commit c2d1300a8e
2 changed files with 74 additions and 7 deletions

72
INSTALL
View File

@ -1 +1,71 @@
Detailed instructions coming soon. In the meantime, follow INSTALL-WSJTX instructions, substituting the WSJT-X repository with this one. # JS8Call
JS8Call is built atop the Qt framework and can be compiled on Linux, Windows, and MacOS.
## Compiling for Linux
### Get the Hamlib Source
mkdir ~/hamlib-prefix
cd ~/hamlib-prefix
git clone https://github.com/Hamlib/Hamlib.git src
### Get the JS8Call Source
mkdir ~/js8call-prefix
cd ~/js8call-prefix
git clone https://bitbucket.org/widefido/js8call.git src
### Get the Dependencies
Most Debian-based distributions make it very easy to install the required dependencies. Other distributions may require a little more effort.
JS8Call depends on:
* Qt5
* FFTW3
* Hamlib
#### 18.04 LTS:
sudo apt install build-essential git automake cmake clang gfortran libfftw3-dev git libgfortran3 libusb-1.0-dev autoconf libtool texinfo qt5-default qtmultimedia5-dev libqt5multimedia5-plugins libqt5serialport5-dev libudev-dev pkg-config
#### 20.04 LTS:
sudo apt install build-essential git automake make cmake clang gfortran libfftw3-dev git libgfortran-10-dev libusb-1.0-0-dev autoconf libtool texinfo qt5-default qtmultimedia5-dev libqt5multimedia5-plugins libqt5serialport5-dev libudev-dev pkg-config
### Compile Hamlib
cd ~/hamlib-prefix/src
./bootstrap
mkdir ../build
cd ../build
../src/configure --prefix=$HOME/hamlib-prefix \
--disable-shared --enable-static \
--without-cxx-binding --disable-winradio \
CFLAGS="-g -O2 -fdata-sections -ffunction-sections" \
LDFLAGS="-Wl,--gc-sections"
make
make install-strip
### Compile JS8Call
cd ~/js8call-prefix/src
mkdir ../build
cd ../build
cmake -D CMAKE_PREFIX_PATH=~/hamlib-prefix -D CMAKE_INSTALL_PREFIX=~/js8call-prefix ../src
make
### Package JS8Call (.deb, .rpm, etc)
cd ~/js8call-prefix/build
cmake -D CMAKE_PREFIX_PATH=~/hamlib-prefix -D CMAKE_INSTALL_PREFIX=~/js8call-prefix ../src
make package
## Compiling for Windows
TODO
## Compiling for MacOS
TODO

9
README
View File

@ -1,10 +1,6 @@
# JS8Call # JS8Call
FT8 has taken over the airwaves as the digital communication mode for making QSOs over HF/VHF/UHF. The mode has been widely popular as the latest offering in K1JTs WSJT-X application. FT8 is based on the same foundation as JT65, JT9, and WSPR modes for weak signal communication, but transmits faster with only slightly reduced sensitivity. JS8Call is an experiment in combining the robustness of FT8 (a weak-signal mode by K1JT) with a messaging and network protocol layer for weak signal communication. The open source software is designed for connecting amateur radio operators who are operating under weak signal conditions and offers real-time keyboard-to-keyboard messaging, store-and-forward messaging, and automatic station announcements.
While FT8 is an incredibly robust weak signal mode, it is designed heavily to take advantage of short band openings on HF/VHF/UHF and only offers a minimal QSO framework. However, many operators are using these weak signal qualities to make successful QSOs on the HF bands where other modes fail.
JS8Call is an experiment to test the feasibility of a digital mode with the robustness of FT8, combined with a messaging and network protocol layer for weak signal communication on HF, using keyboard-to-keyboard style interface. JS8Call is heavily inspired by WSJT-X, Fldigi, and FSQCall and would not exist without the hard work and dedication of the many developers in the amateur radio community.
* Read more on the original design inspiration here: https://github.com/jsherer/js8call * Read more on the original design inspiration here: https://github.com/jsherer/js8call
@ -15,7 +11,7 @@ JS8Call is an experiment to test the feasibility of a digital mode with the robu
# Notice # Notice
JS8Call is a derivative of the WSJT-X application, restructured and redesigned for message passing using FT8 modulation. It is not supported by nor endorsed by the WSJT-X development group. While the WSJT-X group maintains copyright over the original work and code, JS8Call is a derivative work licensed under and in accordance with the terms of the GPLv3 license. The source code modifications are public and can be found in this repository: https://bitbucket.org/widefido/js8call/ JS8Call is a derivative of the WSJT-X application, restructured and redesigned for message passing using a custom FSK modulation called JS8. It is not supported by nor endorsed by the WSJT-X development group. While the WSJT-X group maintains copyright over the original work and code, JS8Call is a derivative work licensed under and in accordance with the terms of the GPLv3 license. The source code modifications are public and can be found in js8call branch of this repository: https://bitbucket.org/widefido/js8call/
# History # History
@ -49,3 +45,4 @@ JS8Call is a derivative of the WSJT-X application, restructured and redesigned f
* April 1, 2019 - Version 1.0.0 general availability - Public Release! * April 1, 2019 - Version 1.0.0 general availability - Public Release!
* June 6, 2019 - Version 1.1.0 general availability * June 6, 2019 - Version 1.1.0 general availability
* November 29, 2019 - Version 2.0.0 general availability - Fast and Turbo speeds introduced! * November 29, 2019 - Version 2.0.0 general availability - Fast and Turbo speeds introduced!
* December 22, 2019 - Version 2.1.0 general availability - Slow speed introduced!