WSJT-X/doc
2021-02-19 09:16:27 -06:00
..
common Updated URLs for recommended Windows Open SSL installers 2020-10-23 01:40:38 +01:00
design improve physical structure 2019-07-02 12:45:05 -05:00
user_guide/en Add discussion of noise blanker in FST4 section of docs. 2021-02-19 09:16:27 -06:00
building on MS Windows.txt Doc updates 2020-11-16 13:06:38 +00:00
building-Boost-libs.txt Updated instructions for building the Boost C++ libraries 2020-11-26 12:33:51 +00:00
CMakeLists.txt Repair User Guide file name, asciidoctor macros, web fetch URL 2020-11-16 03:07:35 +00:00
README Switch to ascidoctor for User Guide generation 2015-11-19 00:08:30 +00:00

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