From 7909c5b8187ca24e37669c20ce4fa944ababe238 Mon Sep 17 00:00:00 2001 From: Greg Beam Date: Thu, 30 Jan 2014 18:40:16 +0000 Subject: [PATCH] User Guide Updates * Main Page - (3.3) Changed OS x DL links to "osx_" vs "osx-" in the ref links. - Updated main page links. I think we should consider an include::file v.s - line item listing, as the list is getting kinda long. - Updated quick-reference guide * (3.4) Added a section to wsjtx-main.adoc for Linux Compile form Source. This needs work as I basically pulled the steps from my local build script. While it works nicely in unattended mode, in an interactive shell, it's not very tidy as there are too many steps. * (3.4) Install Package list should be fairly accurate, Ive' tested it on several new installs, without iussue, once I had the kvasd deps figured out. git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3674 ab8295b8-cf94-4d9e-aec4-7959e3be5d79 --- doc/source/install-from-source.adoc | 114 +++++++++++-- doc/source/install-mac.adoc | 6 +- doc/source/quick-reference.adoc | 240 +++++++++++++++++++++------- doc/source/wsjtx-main.adoc | 38 +++-- kvasd.dat | Bin 2048 -> 2048 bytes mainwindow.cpp | 2 +- 6 files changed, 317 insertions(+), 83 deletions(-) diff --git a/doc/source/install-from-source.adoc b/doc/source/install-from-source.adoc index 36aedd1c8..05ad5452f 100644 --- a/doc/source/install-from-source.adoc +++ b/doc/source/install-from-source.adoc @@ -2,21 +2,113 @@ // Note to developers. The URL http://developer.berlios.de/projects/wsjt/. is // to a very old src version of WSJT 5.7 or so. WSJTX is not listed at all. // Also, all the Qt4 stuff is now obsolete, and needs to be updated. +==== Linux Makefile Example -Source code is available from the public repository at {devsvn}. To +// We need a better solutuion, I basically used my buuild scripts to outline +// The steps here. Auto-tools or a good script much better way to go. +The example below has been tested on Ubuntu 64-bit: 12.04-LTS, 13.10 and +14.04-Dev. Source code is available from the public repository at {devsvn}. To compile the program you will need to install the following packages: -- Subversion -- Qt 5.x -- g++ -- gfortran or g95 -- fftw3 -- hamlib -- MinGW (for Windows only) +.General Pkg Requirments +[horizontal] ++gcc+:: GNU C Compiler ++g{plus}{plus}+:: GNU C{plus}{plus} Compiler ++gfortran+:: GNU FOrtran or F90 ++make+:: GNU Make ++libqt5multimedia5-plugins+:: QT5 Media Plugins ++libfftw3-dev+:: Fast Fourier Transformation ++libpulse-dev+:: Headers and Files for Pulse AUdio ++libhamlib-dev+:: Headers and Files for Hamlib ++qtbase5-dev+:: QT5 Base Dev Files ++qtmultimedia5-dev+:: Qt5 Multimedsia Dev Files ++pulseaudio+:: Pulse Audio Sound Driver ++subversion+:: Version Control Software -With Subversion installed, the full source code for _WSJT-X_ can be -downloaded with the command: +.kvasd 32-bit required libraries +[horizontal] ++libgfortran.so.3+:: from => libgfortran3:i386 ++libc.so.6+:: from => libc6-i386 ++libm.so.6+:: from => libc6-i386 ++libgcc_s.so.1+:: from => lib32gcc1:i386 ++libquadmath.so.0+:: from => lib32quadmath0 + +.Setup and Build +[source,bash] +----- +# In a terminal Ctrl+Alt+T +# Each line is seperate action - Copy & Paste + +mkdir -p ~/Projects/wsjtx-build && cd ~/Projects/wsjtx-build + +svn co svn://svn.berlios.de/wsjt/branches/wsjtx + +cd ./wsjtx/lib && make -f Makfile.linux + +cd ../ && export QT_SELECT=qt5 && qmake + +j_c=$(grep -c ^processor /proc/cpuinfo) && make -j$j_c + +# now mv wsjtx_intall to the new rev-number + +rev_num=$(svn log -l1 |awk 'FNR==2 {print $1}') + +mv ./wsjtx_install ./wsjtx-$rev_num + +----- + +NOTE: You should now have (3) files in ./wjstx-$rev_num (jt9, jt9code and wsjtx). +By moving the directory, your setup for a clean make again if need be. + +.Finial Configuraiton +Before running _WSJT-X_, we need to download kvasd, and link several file(s). + +[source,bash] +----- +# cd to the launch directory +cd ./wsjtx-$rev_num + +wget http://www.physics.princeton.edu/pulsar/K1JT/kvasd +chmod +x ./kvasd + +# Links Files and Folders +ln -s ../wsjtx/kvasd ./kvasd +ln -s ../wsjtx/kvasd.dat ./kvasd.dat +ln -s ../wsjtx/CALL3.TXT ./CALL3.TXT +ln -s ../wsjtx/cty.dat ./cty.dat +ln -s ../wsjtx/Palettes ./Palettes +ln -s ../wsjtx/samples ./samples +ln -s ../wsjtx/mouse_commands.txt ./mouse_commands.txt +ln -s ../wsjtx/shortcuts.txt ./shortcuts.txt +ln -s ../wsjtx/prefixes.txt ./prefixes.txt +----- + +IMPORTANT: You can copy or link the files {amp} folders but make sure they are +in the same directory as the _WSJT-X_ binary. + +.Test kvasd Can Run Properly +Before you run _WSJT-X_, you should ensure _kvasd_ is available and functioning +properly. While still in wsjtx-$rev_num ; + +[source,bash] +----- +# Test to ensure kvasd has all the requred libraries it needs with: +ldd ./kvasd + +# If there were no missing library links, test that kvasd will run +./kvasd + +# If sucessful, K1JT's copyright message should be displayed. +----- + +.Run the New Binary +[source,bash] +----- +./wsjtx +----- + +// Need example using CMakefile +==== Linux, CMake Example - svn co svn://svn.berlios.de/wsjt/branches/wsjtx // Need further compiling Instructions diff --git a/doc/source/install-mac.adoc b/doc/source/install-mac.adoc index 30f7887ac..8b514a4d0 100644 --- a/doc/source/install-mac.adoc +++ b/doc/source/install-mac.adoc @@ -4,14 +4,14 @@ Two different packages are available: one for OS X 10.6 through 10.8, and one for OS X 10.9. The two packages are _not_ interchangeable. - Select the correct package for your OS X and download it to your desktop. -** {osx-108} -** {osx-109} +** {osx_108} +** {osx_109} - Double-click on the file to see a new folder, +WSJT-X+. Drop down into that folder, where a +Readme+ file provides detailed instructions on how to configure your system for _WSJT-X_. - Additional information from package developer G4KLA -can be found {osx-instructions}. +can be found {osx_instructions}. // Any necessary instructions about time synchronization or sound setup ?? diff --git a/doc/source/quick-reference.adoc b/doc/source/quick-reference.adoc index fc8fad60f..f974eded9 100644 --- a/doc/source/quick-reference.adoc +++ b/doc/source/quick-reference.adoc @@ -3,29 +3,44 @@ // users to browse the Page Source = AsciiDoc Quick Reference :Author: WSJT-X Documetation Team -:Date: January 22, 2014, Copyright © CC-BY-SA 3.0 Unported +:Date: January 22, 2014, Copyright (C) CC-BY-SA 3.0 Unported :Revision: 0.0.1 :badges: :icons: :numbered: :image_dir: -// web-links +// WEB links - List is getting pretty long, time to use include::file-name ?? :asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ] :asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[ AsciiDoc Cheatsheet ] :asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[ AsciiDoc FAQ ] +:debian: http://www.debian.org/[ Debian ] :cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ] -:devsvn: http://developer.berlios.de/projects/wsjt/[Devel-SVN] +:devsvn: http://developer.berlios.de/projects/wsjt/[ Devel-SVN ] +:devsvn: http://developer.berlios.de/projects/wsjt/[wsjt-svn] :download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ] +:dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ] :homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] +:hrd: http://www.hrdsoftwarellc.com/[ Ham Radio Deluxe ] +:jtalert: http://ham-apps.com[JT-ALERT-X] +:jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] +:launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ] :ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] +:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] +:osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here] :wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] -:page_source: ./source/quick-reference.txt[ Page Source ] -// mail-to links -:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ] +// DOWNLOAD links +:cty_dat: http://www.country-files.com/cty/[here]. +:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] +:osx_108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ] +:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[ OS X 10.9 ] + +// MAIL-TO links :alex_efros: mailto:powerman@powerman.name[ Alex Efros ] -:devmail: mailto:wsjt-devel@lists.berlios.de[WSJT-Devel-List] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] +:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ] + [[X1]] == Introduction @@ -38,99 +53,212 @@ examples can be found at: * {asciidoc_cheatsheet} by {alex_efros} [[X2]] -== Asciidoc Install - -For _WSJT-X_ documentation purposes, only (2) dependencies are generally -required: - -* Python -* Source highlight +== Asciidoc Installation For most packages, the normal method of installation is through their respective package manager. There are several reasons why we do not want this for the _WSJT-X User Guide_: -** Most packaged applications are installed system-wide, which means standard +* Most packaged applications are installed system-wide, which means standard pivilaged (non Root / RootSudo) users update their binaries. -** Often times, distro packages are (1) or more revisions behind. -** Updating to the latest stable _AscciDoc_ version, using Mercurial, is a simple -one line command: _hg pull ; hg update ; hg upgrade_, or clone a new binary -set with _hg clone -r 8.6._ then re-link the new binary. -** Using $HOME makes working on the _WSJT-X User Guide_ portable, such as, -installing to a USB Key and allowing you to test build your work on virtually -any system that has _Python_ {amp}{amp} _Bash Enviroment_ installed. +* Often times, distro packages are (1) or more revisions behind. +* Updating to the latest stable _AsciiDoc_ version, using Mercurial, is a simple +one line command or simply clone the latest release. +* Using $HOME makes working on the _WSJT-X User Guide_ portable, such as, +installing to a USB Key allows testing of your work on virtually any system +which has _Python_ {amp}{amp} _Bash Enviroment_ installed. // Several more items pending addition -_Further Edited Pending_ - +*Further Edit's Pending* [[X21]] === Windows +.WinXP thru Win8 -Install Instructions: - -==== Vista, Win7, Win8 - -Install Instructions: +content [[X22]] === Linux +.Debian, Ubuntu, Mint {amp} Relatives +// Rouch Draft, needs verified. -==== Ubuntu, Debian, Mint and relatives +There are many relatives of Debian {amp} Ubuntu, and most shells are _Bash_. For +all but the package-manager commands,you shoult be able to _Copy {amp} Paste_ +the commands directly into the terminal. -Install Instructions: +* It's a good idea to always start from a fresh repository list, and to have the +instll up to date before adding new packages. -==== RedHat, Fedora, CentOS, and relatives +[source,bash] +----- +sudo apt-get update && sudo apt-get upgrade +----- -Install Instructions: +* Install Dependencies -==== Slackware +[source,bash] +----- +# on most distro's, python is already installed +sudo apt-get install mercurial source-highlight subversion +----- -Install Instructions: +* Check Python, hg, Subversion and Source Highlight are installed -==== Linux Other +[source,bash] +----- +python -V +hg --version |head -n1 +svn --version |head -n1 +source-highlight --version |head -n1 +----- + +* Should Return: + +[source,bash] +----- +# your versions may vary slightly +Python 2.7.6 +svn, version 1.7.14 +Mercurial Distributed SCM (version 2.8.2) +GNU Source-highlight 3.1.6 +----- + +IMPORTANT: If any package check returns with an error, resolve before +continuing !! + +* Check for Previous AsciiDoc Installation + +[source,bash] +----- +# ckeck if AsciiDoc is already installed: +asciidoc --version + +# If Bash returns any version, remove it: +sudo apt-get purge asciidoc +----- + +* Add Directories and source profiles + +[source,bash] +----- +mkdir -p $HOME/bin $HOME/Projects/documentation/wsjtx + +source ~/.bashrc && source ~/.profile +----- + +* Check $HOME/bin is in your $PATH + +[source,bash] +----- +echo $PATH + +#should return something like: /home/$USER/bin:/usr/local/sbin: .. .. .. +----- + +NOTE: You may have to log out and back in for the addition to take place. +If need be, add the following to your shell profile, then source or +log out / back in: + +[source,bash] +----- +if [ -d "$HOME/bin" ] +then + PATH="$HOME/bin:$PATH" +fi +----- + +* Download and Configure _AsciiDoc_ use _Copy {amp} Paste_ + +[source,bash] +----- +# one action per line +cd ~/bin + +hg clone -r 8.6.9 https://asciidoc.googlecode.com/hg/ asciidoc-8.6.9 + +cd asciidoc-8.6.9 && hg pull && hg update && hg upgrade && cd .. + +ln -s ~/bin/asciidoc-8.6.9/asciidoc.py ~/bin/asciidoc + +asciidoc --version + +# Should return: asciidoc 8.6.9 +----- + +* Test build _WSJT-X User Guide_ + +[source,bash] +----- +cd ~/Projects/documentation/wsjtx +----- + +TIP: There are two commands generally used, _svn export_ and _svn checkout_. +_svn export_ does _[red]#not#_ pull history ( the .svn folders ), and you cannot +be updated later. _svn checkout_ does pull history and allows you to use _svn up_ +to bring you local copy to the latest repo level. + +[source,bash] +----- +svn export svn://svn.berlios.de/wsjt/branches/wsjtx/doc + +# and / or + +svn checkout svn://svn.berlios.de/wsjt/branches/wsjtx/doc + +# then + +cd ~/Projects/documentation/wsjtx && ./build-doc.sh toc2 +----- + +* Now Open wsjtx-main-toc.html + +[source,bash] +----- +# for chromium +chromium-browser wsjtx-main-toc2.html + +# for FireFox +firefox wsjtx-main-toc2.html +----- -Install Instructions: [[X23]] === OS X +.10.8 {amp} 10.9 -Install Instructions: +content [[X3]] == How To Contribute -.Under Construction +.under contstruction -=== Blocks -.Under Construction +content -Content needed. +=== Dev List Email +.under contstruction -=== Headers -.Under Construction +content -Content needed. +=== Join {amp} Commit +.under contstruction -=== Links -.Under Construction +content -Content needed. +=== Submit Patch +.under contstruction -=== Lists -.Under Construction +content -Content needed. +=== Yahoo Group Post +.under contstruction -=== Notes -.Under Construction - -Content needed. +content [[X36]] === Text .Under Construction -Content needed. +content [[XA1]] == Appendix A: Credits diff --git a/doc/source/wsjtx-main.adoc b/doc/source/wsjtx-main.adoc index faf3cfc94..7fcaf5b0d 100644 --- a/doc/source/wsjtx-main.adoc +++ b/doc/source/wsjtx-main.adoc @@ -7,28 +7,42 @@ :badges: :icons: :numbered: +:image_dir: // If the list of links gets too long, we can add a url-file that is pulled // in when and where needed with the following: // include:: for example: include::url-list.txt + +// WEB links - List is getting pretty long, time to use include::file-name ?? +:asciidoc_help: http://www.methods.co.nz/asciidoc/userguide.html[ AsciiDoc User Guide ] +:asciidoc_cheatsheet: http://powerman.name/doc/asciidoc[ AsciiDoc Cheatsheet ] +:asciidoc_questions: http://www.methods.co.nz/asciidoc/faq.html[ AsciiDoc FAQ ] +:debian: http://www.debian.org/[ Debian ] +:cc_by_sa: http://creativecommons.org/licenses/by-sa/3.0/[ Commons Attribution-ShareAlike 3.0 Unported License ] :devsvn: http://developer.berlios.de/projects/wsjt/[wsjt-svn] -:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] :download: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ Download Page ] -:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] -:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] -:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] :dxlcommander: http://www.dxlabsuite.com/commander/[ Commander ] +:homepage: http://physics.princeton.edu/pulsar/K1JT/[ WSJT Home Page ] :hrd: http://www.hrdsoftwarellc.com/[ Ham Radio Deluxe ] -:image_dir: -:launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ] -:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] -:osx-instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here] -:osx-108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ] -:osx-109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[OS X 10.9] -:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] -:jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] :jtalert: http://ham-apps.com[JT-ALERT-X] +:jt65protocol: http://physics.princeton.edu/pulsar/K1JT/JT65.pdf[QEX] +:launchpadurl: https://launchpad.net/~jnogatch/+archive/wsjtx[ WSJT-X Linux Packages ] +:ntpsetup: http://www.satsignal.eu/ntp/setup.html[Network Time Protocol Setup] +:pskreporter: http://pskreporter.info/pskmap.html[PSK Reporter] +:osx_instructions: http://physics.princeton.edu/pulsar/K1JT/OSX_Readme[here] +:wsjtx: http://physics.princeton.edu/pulsar/K1JT/wsjtx.html[ WSJT-X ] + +// DOWNLOAD links :cty_dat: http://www.country-files.com/cty/[here]. +:kvasd: http://physics.princeton.edu/pulsar/K1JT/kvasd[kvasd] +:osx_108: http://physics.princeton.edu/pulsar/K1JT/wsjtx_3nov13.tar.gz[ OS X 10.6, 10.7, and 10.8 ] +:osx_109: http://physics.princeton.edu/pulsar/K1JT/wsjtx_10.9_29nov13.tar.gz[ OS X 10.9 ] + +// MAIL-TO links +:alex_efros: mailto:powerman@powerman.name[ Alex Efros ] +:devmail: mailto:wsjt-devel@lists.berlios.de[wsjt-devel] +:stuart_rackman: mailto:srackham@gmail.com[ Stuart Rackham ] + // These [[xxxx]] labels are HTML anchors, and can be used to // navigate though the document easily: <<[INTRO],See Introduction]>> will diff --git a/kvasd.dat b/kvasd.dat index f7f15df564cc483e4e94d746d2181b2e933e7738..19b26b81494758ba829b628f3900cac062c9b32a 100644 GIT binary patch literal 2048 zcmeH`SxUoD6hNccYO&U#b--ecSZu4+4i2;;jeGIW#kmf*;ATwEffVu)LVg4(xo~*H zo$~IzX$C>i`ikFoSifNo=Wqixcz`KvgSuNdgce+Zx;tpV0Ip#HZ(t1fAv}WT3N%4q z&&O~AXJC9|m{b2JFrT@fll7E!7yRB0Fz*(OK>IF?6ZF-t4@2mHx&tt89U@R?j8BMj z_{h=a`Td2?w`RrtN!|aZ_F1;+yBW4^=z%q}p7v}L)LComX0Jj}XRq8_U;QGm->bbn zn)eFN+4-?Q7hrs2m{b23aHh=dJH0;wd%Fk9KKPyXPJ3s`T(97_YIhIL(j|EB rT$|TB`|nx>CBDC?_%FstQTx)atUy_T^{K!T247VM literal 2048 zcmeH`SxN&i5I~Fjz6&ZYMR1`Nm%1xxkD?yJ-=4$^2zm$q{PYywK~(B{Fax282apat zX31odOp->WQki>hH;2%#FbN|t8XTby;0k(R7tC3JemH~`FvoG{Ie$5H`o@wo>`mB< z*hc7F^Ai6Y^tYiGros8H=bo~bIje9SvD1#R8h!(^_F&kqk@eJD;5pjx5?cEnZebo~ z!9E!u4*h^`!A|&&eHXTV8FT%Nsc+z;h<#!|hQEY%-M8?|d1*ftW4X5+^UP^~VULAx zuilF>bG%FQ?S-5`9j=2ZbPX0^9lUSvcpr>A$NAoA)=`(t;M?bV#I2dR&c6WP#sK)n z+=D$g$My8J?Y;SHPz7VoRf}WR@vUe}HMI9+j`h@@#d}wL<0-x=@5-LK7i}f=9d--s z>0jcXP&`v9b2#=qr4OSS&N$k0PlW%Q@?WHM*3LaT?%zq@x}D