WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-01 08:07:10 -04:00

History

Joe Taylor b16b774592 Update the CMakeLists.txt for docs. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7239 ab8295b8-cf94-4d9e-aec4-7959e3be5d79		2016-10-26 16:47:59 +00:00
..
common	More tweaks to user Guide.	2016-09-08 20:30:12 +00:00
user_guide/en	MOre edits to User Guide.	2016-10-26 16:44:04 +00:00
CMakeLists.txt	Update the CMakeLists.txt for docs.	2016-10-26 16:47:59 +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