WSJT-X/doc
sirhc808 27d4471cde Merge branch 'ft9_refactor' into feat-refactor
# Conflicts:
#	CMakeLists.txt
#	lib/ft4/getcandidates4.f90
#	lib/ft4/sync4d.f90
2019-07-02 12:06:14 -05:00
..
common Updates to the User Guide, mostly related to addition of the FT4 mode. 2019-06-06 13:44:32 -04:00
design start refactoring UML docs 2019-07-02 11:50:55 -05:00
user_guide/en Editorial work on parts of the User Guide related to FT4. 2019-06-17 15:47:47 -04:00
CMakeLists.txt Add a User Guide tutorial section for FT4. 2019-06-06 14:15:12 -04: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