WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-21 19:55:20 -05:00

History

Bill Somerville 7cda91c759 Improve the "translatability" of some of the User Guide links To aid translators some of the links in the doc/common/links.adoc file, which is shared by all translations, have been changed to remove generic link text like "here" with the titles of the linked references. Since these are in the language of the references documents there is no need to translate these. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6647 ab8295b8-cf94-4d9e-aec4-7959e3be5d79		2016-04-24 19:45:52 +00:00
..
common	Improve the "translatability" of some of the User Guide links	2016-04-24 19:45:52 +00:00
user_guide/en	Improve the "translatability" of some of the User Guide links	2016-04-24 19:45:52 +00:00
CMakeLists.txt	Only generate USLetter size PDFs for languages that might need it	2016-04-24 19:05:03 +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