mirror of
https://github.com/saitohirga/WSJT-X.git
synced 2024-11-18 10:01:57 -05:00
dc672c4bb1
Requires Ruby and asciidoctor to be installed. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6131 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
41 lines
923 B
Plaintext
41 lines
923 B
Plaintext
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
|