WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-05 08:51:19 -05:00

History

Bill Somerville 8416a177fe Docs correction		2020-11-14 14:23:58 +00: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	A few more edits for User Guide.	2020-09-24 11:01:04 -04:00
building on MS Windows.txt	Documentation updates	2020-10-29 22:40:19 +00:00
building-Boost-libs.txt	Docs correction	2020-11-14 14:23:58 +00:00
CMakeLists.txt	First cut at adding FST4, FST4W to the User Guide.	2020-09-23 15:03:33 -04: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