WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-01 16:13:57 -04:00

History

Bill Somerville 2bd71bfd2f Add PDF generation to docs target Cleaned up some syntax anomolies because of the switch to asciidoctor. Minor text tweaks to improve PDF pagination. Reduced HTML master font size to 80% for better web rendering. Removed references to KVASD from User Guide. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6142 ab8295b8-cf94-4d9e-aec4-7959e3be5d79		2015-11-21 02:34:20 +00:00
..
common	Add User Guide text on WSPR band-hopping.	2015-11-17 14:42:16 +00:00
user_guide	Add PDF generation to docs target	2015-11-21 02:34:20 +00:00
CMakeLists.txt	Add PDF generation to docs target	2015-11-21 02:34:20 +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