WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-21 19:55:20 -05:00

History

Steve Franke b03acdfce3 Define a custom button labeled Discard Measured to replace the standard Discard button. This is being done to ensure that the button label is the same on different platforms. Update the documentation to reference the new Button name.		2018-06-08 17:39:57 -05:00
..
common	More updates to the v1.9 User Guide.	2018-02-16 13:51:55 +00:00
user_guide/en	Define a custom button labeled Discard Measured to replace the standard Discard button. This is being done to ensure that the button label is the same on different platforms. Update the documentation to reference the new Button name.	2018-06-08 17:39:57 -05:00
CMakeLists.txt	Several additions/tweaks to User Guide.	2018-02-22 13:55:42 +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