WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-09 02:26:06 -05:00

History

Bill Somerville 3d081a09a8 Update documentation URLs to SSL/TLS where available Some like *.princeton.edu now require this.		2020-06-30 13:22:59 +01:00
..
common	Update documentation URLs to SSL/TLS where available	2020-06-30 13:22:59 +01:00
design	improve physical structure	2019-07-02 12:45:05 -05:00
user_guide/en	Remove references to Windows XP and Vista from User Guide	2020-06-24 14:38:21 +01:00
CMakeLists.txt	Updates to User Guide: Dark Style, translated UIs, ...	2020-05-19 15:18:13 -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