WSJT-X/doc
Bill Somerville 4a416175d2 Merged from trunk:
------------------------------------------------------------------------
r8005 | bsomervi | 2017-08-05 14:29:55 +0100 (Sat, 05 Aug 2017) | 5 lines

User guide and help text updates

Details  of --config  command line  option. Note  that low  confidence
decodes '?'  are not spotted and  more generic text for  --help command
line option now derived from CMakeLists description strings.
------------------------------------------------------------------------



git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx-1.8@8007 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-08-05 13:36:14 +00:00
..
common Start the ball rolling on the User Guide for WSJT-X v1.8 2017-07-11 22:51:49 +00:00
user_guide/en Merged from trunk: 2017-08-05 13:36:14 +00:00
CMakeLists.txt Merged from trunk: 2017-08-04 22:12:06 +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