WSJT-X

mirror of https://github.com/saitohirga/WSJT-X.git synced 2024-11-27 06:38:44 -05:00

History

Bill Somerville 73b1b35685 Make install locations configuration variables Locations of various components to be determined at configuration time. This allows various "Standard" system layouts to be accomodated. For example on FreeBSD the manpages are usually installed in the man directory i.e. /usr/local/man whereas the WSJT-X default is to install them in share/man i.e. /usr/share/man. By setting the CMake variable WSJT_MANPAGE_DESTINATION to either a relative or absolute path the install location can be set: $ cmake -D WSJT_MANPAGE_DESTINATION=. ... will install the manpages at ${CMAKE_INSTALL_PREFIX}/man The new configuration variables are: WSJT_BIN_DESTINATION WSJT_LIB_DESTINATION WSJT_SHARE_DESTINATION WSJT_DOC_DESTINATION WSJT_DATA_DESTINATION WSJT_MANPAGE_DESTINATION WSJT_PLUGIN_DESTINATION WSJT_QT_CONF_DESTINATION NB: changes to the above may break WSJT-X at present where the install locations of files used directly by WSJT-X are moved. Warning: using absolute paths for these variables is not recommended as files may be installed in unexpected places, particularly when run with root privileges. All relative paths with be relative to CMAKE_INSTALL_PREFIX. Merged from ^/branches/wsjtx. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx-1.6@6201 ab8295b8-cf94-4d9e-aec4-7959e3be5d79		2015-11-29 11:19:44 +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	Make install locations configuration variables	2015-11-29 11:19:44 +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

README

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.