Requires Ruby and asciidoctor to be installed.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6131 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
is now strongly encouraged! We "go to press" soon!
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@6090 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
Linux, and OS X sub-sections similar in appearance.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5457 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
This merge brings the WSPR feature development into the main line
ready for release in a future v1.6 release.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5424 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
The file doc/theme/wsjt.css is the theme CSS file and it contains the
contents of the standard asciidoc.css file followed by WSJT specific
CSS overrides. If required a file doc/theme/wsjt.js may be added at a
later date.
git-svn-id: svn+ssh://svn.code.sf.net/p/wsjt/wsjt/branches/wsjtx@5369 ab8295b8-cf94-4d9e-aec4-7959e3be5d79
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
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
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
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
** 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
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
** 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
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
* 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
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
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
* 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
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
