WSJT-X/doc
Joe Taylor 3afb5508e3 Mistakenly omitted including the file "implementation.adoc".
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6113 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-11-17 16:56:34 +00:00
..
common Add User Guide text on WSPR band-hopping. 2015-11-17 14:42:16 +00:00
theme/wsjt Fix visited link colour in wsjt asciidoc theme for user guide 2015-05-12 21:48:28 +00:00
user_guide Mistakenly omitted including the file "implementation.adoc". 2015-11-17 16:56:34 +00:00
CMakeLists.txt Many more edits of the User Guide. 2015-11-16 20:13:47 +00:00
README Some info for developers 2015-04-29 11:33:31 +00:00
wsjtx.conf.in Add an asciidoc theme so that project specific CSS can be used 2015-05-12 21:32:18 +00:00

This folder  contains the sources  of WSJT-X documentation.   To build
these you will need the asciidoc and Python v2 tools 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 asciidoc

or

 sudo yum install asciidoc

or whatever your distribution and package management requires.


On Mac OS X
===========

I recommend MacPorts:

 sudo port install asciidoc


On Windows
==========

The asciidoc  tool is a  Python script so you  will need to  install a
version of  Python v2. If  you already have  Python v3 as  the default
Python interpreter on your system  then download and install Python v2
(probably v2.7.x) but  adjust the installer options so as  not to make
it  the  default  system  Python   interpreter,  this  is  normally  a
configuration option in the MSI installer.

The current  version of asciidoc (8.6.9)  is broken on Windows  so you
will need to get the latest development version:

 download https://github.com/asciidoc/asciidoc/archive/master.zip

and unzip  it somewhere like  C:\Tools then you  will need to  add the
path to asciidoc and possibly Python  v2 to your CMake tool chain file
for building WSJT-X. The directory  containing asciidoc.py needs to be
included in the CMAKE_PREFIX_PATH variable.