w4kek/WSJT-X
1
0
Fork 0
mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-21 03:21:58 -05:00
Code Issues Packages Projects Releases Wiki Activity
master
WSJT-X/doc
History
Joe Taylor a4792074e4 Edits to User Guide and Release Notes.
2022-07-15 14:21:06 -04:00
..
common Edits to the user Guide: explicit link to the wsjt-devel subscribe page. 2022-05-31 09:40:59 -04:00
design improve physical structure 2019-07-02 12:45:05 -05:00
user_guide/en Edits to User Guide and Release Notes. 2022-07-15 14:21:06 -04:00
building on MS Windows.txt Correct a script example in documentation 2021-06-11 12:22:07 +01:00
building portaudio on Windows with ASIO support.txt Updated instructions to build portaudio with ASIO support 2021-10-05 19:41:39 +01:00
building-Boost-libs.txt Updated Boost library build information to include Boost::timer 2021-06-09 12:43:19 +01:00
CMakeLists.txt Edits and additions to User Guide. 2022-06-02 13:15:20 -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