WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-13 23:51:49 -05:00

History

Joe Taylor a12a72836a Update User Guide for the $DXCALL macro facility.		2021-12-07 10:13:48 -05:00
..
common	User Guide updates and new contributor acknowledgement	2021-10-21 15:15:02 +01:00
design	improve physical structure	2019-07-02 12:45:05 -05:00
user_guide/en	Update User Guide for the $DXCALL macro facility.	2021-12-07 10:13:48 -05:00
building on MS Windows.txt	Correct a script example in documentation	2021-06-11 12:22:07 +01:00
building portaudio on Windows with ASIO support.txt	Updated instructions to build portaudio with ASIO support	2021-10-05 19:41:39 +01:00
building-Boost-libs.txt	Updated Boost library build information to include Boost::timer	2021-06-09 12:43:19 +01:00
CMakeLists.txt	First cut at User Guide changes to section 6 to replace JT9 with FT8.	2021-07-27 09:25:18 -05:00
README	Switch to ascidoctor for User Guide generation	2015-11-19 00:08:30 +00:00

README

This folder  contains the sources  of WSJT-X documentation.   To build
these you will need the asciidoctor tool installed.

If you do not wish to build  the documentation, it is possible to skip
this  directory  in the  WSJT-X  build  by  setting the  CMake  option
WSJT_GENERATE_DOCS to OFF in your build tree.


On Linux
========

You will probably have these installed already if you are building the
WSJT-X  manpages,  if you  are  not  you  will  just need  to  install
asciidoc:

 sudo apt-get install asciidoctor

or

 sudo yum install asciidoctor

or whatever your distribution and package management requires.


On Mac OS X
===========

I recommend MacPorts:

 sudo port install rb-rubygems
 sudo gem install asciidoctor


On Windows
==========

The asciidoctor  tool is a  Ruby script so you  will need to  install a
version of Ruby. The gem tool is a good way to install asciidoctor:

   gem install asciidoctor