w4kek/WSJT-X
1
0
Fork 0
mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-01 16:13:57 -04:00
Code Issues Packages Projects Releases Wiki Activity
40e4707bf7
WSJT-X/doc
History
Joe Taylor bb2a0f6dfe Fix a typo. 
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@7651 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2017-04-24 17:09:15 +00:00
..
common A number of minor edits to the User Guide -- mostly thanks to Roger, VE1SKY. 2016-10-31 17:23:51 +00:00
user_guide/en Fix a typo. 2017-04-24 17:09:15 +00:00
CMakeLists.txt Rework install locations for better flexibility 2017-03-28 13:03:48 +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