Commit Graph

271 Commits

Author SHA1 Message Date
Joe Taylor
831124494f 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
a2cf32061c 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
fbe03be98c 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
16b2b3d419 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
d305f8fd36 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
e6f73c8a66 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
7324ece8a7 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
7909c5b818 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
f7e39a2009 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
6ef06bc16f 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
461afef30f 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
43664a2e01 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
a47a4ee38b 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
8d6ea94d77 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
49fe4846ae 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
784e246557 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
23aff84fbb 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
6b80d7b89a 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
d3d0d437f6 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
fd4bc2d602 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
6279c65dca 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