WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-24 13:18:38 -05:00

History

Joe Taylor 3db1b27c06 First cut at replacing QRA64 with Q65 throughout the User Guide.		2021-03-04 11:37:00 -05:00
..
common	First cut at replacing QRA64 with Q65 throughout the User Guide.	2021-03-04 11:37:00 -05:00
design	improve physical structure	2019-07-02 12:45:05 -05:00
user_guide/en	First cut at replacing QRA64 with Q65 throughout the User Guide.	2021-03-04 11:37:00 -05: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 version variable assignments	2021-02-26 16:22:16 +00: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