Commit Graph

32 Commits

Author SHA1 Message Date
Bill Somerville
7ccdb1df55 Some info for developers
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5323 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-29 11:33:31 +00:00
Bill Somerville
f71aa73e9c Ensure that asciidoc configuration file changes trigger doc builds
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5322 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-29 10:25:27 +00:00
Bill Somerville
c0b7afc2f6 Use absolute path for Python interpreter to avoid picking up v3
Because asciidoc  doesn't work with Python  3 we must not  allow it to
run via  a shebang  or Windows  file association,  instead we  now use
find_package()  on Python  and  filter the  version.  This means  that
CMAKE_PREFIX_PATH   can  be   used  to   select  the   correct  Python
installation if there are more than one and one is v3 or newer.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5321 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-29 00:51:52 +00:00
Bill Somerville
cdd088d749 Solve the WSJT-X manual versioning issue
The user guide  is now installed with the product  version in the name
so  serving the  same  file from  the project  web  server will  allow
multiple manual versions to be easily supported.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5320 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 22:59:12 +00:00
Bill Somerville
c5b18d0809 Added automatic VERSION attributes to asciidoc generation
Also tring a few minor technical formatting experiments.

Added  common asciidoc  files  to dependencies  so that  modifications
cause rebuilds.

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5319 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 22:33:32 +00:00
Bill Somerville
3a33bc79f0 Take out invalid custom command output that causes unnecessary rebuilds
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5317 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 19:44:23 +00:00
Bill Somerville
c197d216b3 First attempt at adding the WSJT-X user guide to the CMake build
These documentation source files are not  the one true version, just a
copy for testing purposes. DO NOT EDIT THESE FILES.

To use this  on Windows you will need a  working asciidoc installation
and  the  path  to  it  must be  included  in  your  CMAKE_PREFIX_PATH
(probably via a  local CMake tool chain file). At  the time of writing
the official  asciidoc package does  not work on Windows.   The latest
development  master does  however  work,  it can  be  downloaded as  a
snapshot ZIP archive from here:

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

git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5316 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2015-04-28 18:37:50 +00:00
Joe Taylor
e2c8fd511a Remove docs from their previous location.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3693 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-04 16:56:49 +00:00
Greg Beam
352cb657f9 User Guide Updates
** Update build-doc.sh
- I forgot to change a variable for web_packaging after testing.
Should be working corretly now.

:: @QX9770-SRV1/Win64 ==> Cygwin terminal


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3689 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-04 02:54:17 +00:00
Greg Beam
77ef3c8bd5 User Guide Updates
** Updated Compiling WSJT-X; Linux Makefile
- Mostly formatting for easier reading
- Added caution about using development builds

** build-doc.sh
- minor edits

** wsjtx-main.adoc
- minor edits

:: @QX9770-SRV1/Win64 ==> Cygwin terminal


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3688 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-04 01:13:27 +00:00
Greg Beam
743062de91 User Guide Updates
** Updated build-doc.sh
- Added a feature for Joe
- Removed rig-config build instructions

** Updated wsjtx-main.adoc
-- Fixed syntax error causing highlight issues
-- Removed rig-config section

:: @QX9770-SRV1/Win64 ==> Cygwin terminal


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3687 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-03 20:51:16 +00:00
Joe Taylor
97f9bf9059 1. Added tghe file compiling.adoc
2. Added an initial "Frequenctly Asked Questions" section.  

Please add new Q&A items, as needed (and improve mine if you wish).  Note
that asciidoc seems to require no line breaks within the question.



git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3684 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-03 16:03:44 +00:00
Greg Beam
0a39f4626f User Guide Updates
** Updated Quick Reference Guide
- updated AsciiDoc install for Linux
- added AsciiDoc install for Windows
- changed topics around. need input for topic ideas

** Added empty compiling.adoc & dev-guide.adoc
- holding pages to prevent build script errors

** Build Script Updates
- added help menu = ./build-doc.sh --help
- added options to build dev-guide.adoc or quick-reference.adoc Only
- added direct entry ./build-doc.sh [optoin] or menu selection
- USAGE: ./build-doc.sh [ option ]
- OPTIONS: "" toc1 toc2 all dev-guide quick-ref help

** HELP MENU:
-- [1] No Table of Contents
-- [2] Top Table of Contents
-- [3] Left Table of Contents
-- [4] Build All Guides
-- [5] Development Guide Only
-- [6] Quick Reference Guide Only

: Actions from @QX9770-SRV1/Win64 ==> Cygwin terminal


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3683 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-02 13:25:08 +00:00
Joe Taylor
717cf2c55b Insert "Compiling in Linux" instructions in a separate section near
the end of User's Guide.


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3682 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-01 19:21:16 +00:00
Greg Beam
46f6e3231b User Guide Updates
* Per Joe's request, use TIP v.s. NOTE:

Find [ NOTE: ] 
$ cd ./wsjtx/doc/source
$ grep ^NOTE: ./*
./doc/example1-decoding-overview.adoc:NOTE: .. ..
./doc/example2-check-decodes.adoc:NOTE: .. ..
./doc/example2-wave-2343.adoc:NOTE: .. ..
./quick-reference.adoc:NOTE: .. ..

Change [ NOTE: ] to [ TIP: ]
$ sed -i 's/NOTE:/TIP:/' ./example1-* ./example2-* ./quick-*

$ svn status
M       example1-decoding-overview.adoc
M       example2-check-decodes.adoc
M       example2-wave-2343.adoc
M       quick-reference.adoc

: Actions performed on @QX9770-SRV1/Win64 ==> Cygwin terminal


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3681 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-02-01 10:19:39 +00:00
Joe Taylor
e06244983e 1. Update the example QSOs for Type 2 compound callsigns.
2. Remove the compilation instructions, they will go in a separate section
or a developers guide.


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3678 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-31 18:54:57 +00:00
Joe Taylor
3a8bef9277 Add a warning about setup of messages with compound callsigns.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3676 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-31 15:19:35 +00:00
Joe Taylor
afde68411b Forgot to put utilities.adoc in SVN. Here it is.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3675 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-30 19:09:14 +00:00
Greg Beam
2815fc1b31 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
2014-01-30 18:40:16 +00:00
Joe Taylor
4c00ea666a 1. Add "Utility Programs" section to User's Guide.
2. Change "Appendix x" section headings to useful descriptions.
3. Add KB1ZMX and W4TI to the WSJT-X "About" screen and Acknowledgments 
   in the User's Guide.  (Hope I didn't forget anyone -- please advise 
   if I did!)
4. A few more minor tweaks to User's Guide



git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3672 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-30 18:03:21 +00:00
Greg Beam
7f913b9ea5 User Guide Updates
* mainwindow.cpp
- bumped ver#

* Updated build-doc.sh:
- name changes
- array var for electaft
- added Build Quick Reference Only option
  ./build-doc.sh quick-ref

* Corrected file ext typo: .ado to .adoc

* Started adding material to Quick Reference Guide.

** Tested all (4) build methods, no failures.



git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3671 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-30 10:09:18 +00:00
Greg Beam
9505c97046 User Guide Updates
* mainwindow.cpp
- bumped ver#

* Added updates from Chase, KE4QDL





git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3670 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-30 08:25:09 +00:00
Joe Taylor
d274a49b4f Another round of documentation updates.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3669 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-29 20:50:18 +00:00
Joe Taylor
cb88a54c39 1. Updated two screen pix in User's Guide.
2. Revise, revise, revise.  Good writing requires plenty of revisions!


git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3667 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-28 21:53:09 +00:00
Joe Taylor
2c7a76ffbc Another round of edits for the WSJT-X User's Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3666 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-28 15:24:26 +00:00
Joe Taylor
a3fa39fa68 Yesterday, forgot to add tx-rx.adoc to SVN. Here it is.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3665 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-28 13:12:19 +00:00
Joe Taylor
ace8f6418e 1. Fix a bug that could cause decoder to hang when presented with
bad data.

2. Fix a bug that could allow a Koetter-Vardy false decode instead of
a valid Berlekamp-Massey decode, sometimes leading to program crash.

3. Many more edits in the User's Guide, *.adoc files.



git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3664 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-27 21:28:54 +00:00
Greg Beam
44543d385d User Guide Docs Update
* Moved doc/source/*.txt to AsciiDoc ext source/*.adoc
- Correctly identifies AsciiDoc files

* wsjtx-main.adoc
- Updated links and include:: for *.adoc name change

* Added and updated rig-config-* files.
* Added inital draft of quick-reference.adoc

* build-doc.sh
- Updated the script to build new files and .adoc name change

* Removed:
- yaesu.txt rigtemplate.txt rig-configuration.txt




git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3662 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-25 22:26:21 +00:00
Joe Taylor
426bcc5fcf Another round of extensive edits to the WSJT-X User's Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3658 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-24 20:09:47 +00:00
Joe Taylor
333337a91f Another extensive round of edits for the WSJT-X User's Guide.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3657 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-23 22:13:32 +00:00
Joe Taylor
d6cf422315 Split the asciidoc source for WSJT-X User's Guide into many
smaller files, by section and sub-section.  

Also extensive editing up through section 7.  Sections 6.2, 8, and
beyond definitely need work.  Other polishing is also desirable, and
maybe also some additions and/or changes.



git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3656 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-23 20:12:12 +00:00
Joe Taylor
5bb262246d First commit of the KI7MT documentation directory and contents.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@3655 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
2014-01-21 21:24:56 +00:00