WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-12 15:16:41 -05:00

History

Joe Taylor c5d14da4a1 Add G4WJS and K9AN to title and authorship credits.		2020-05-06 09:38:09 -04:00
..
common	Add a TIP about Alternate F1-F6 bindings to User Guide.	2020-02-28 11:24:24 -05:00
design	improve physical structure	2019-07-02 12:45:05 -05:00
user_guide/en	Add G4WJS and K9AN to title and authorship credits.	2020-05-06 09:38:09 -04:00
CMakeLists.txt	Removed confusing and inaccurate HTML user Guide document footer	2019-11-27 19:18:45 +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