n4ogw / so2sdr

Ham radio contest logging program
http://n4ogw.github.io/so2sdr/
GNU General Public License v3.0
20 stars 3 forks source link

A first draft at a user manual using ASCII Doc #2

Closed N0NB closed 12 years ago

N0NB commented 12 years ago

I'll probably need to combine the existing help file with this manual so that everything is in one place. Please let me know what you think.

73, de Nate >>

n4ogw commented 12 years ago

Yes, I think keeping the manual and help file the same will save a lot of work. Maybe a separate key/macro reference is also needed.

One thing that might help is to fill out all the dialogs with choices that makes sense- like /dev/ttyS0 /etc for the serial ports.

For the bandscope, the program checks each portaudio device and puts a check by the ones that seem to work (support recording). Maybe I can get a screenshot from my system with dual sound cards there.

Tor

--- On Tue, 5/29/12, Nate Bargmann reply@reply.github.com wrote:

From: Nate Bargmann reply@reply.github.com Subject: [so2sdr] A first draft at a user manual using ASCII Doc (#2) To: "n4ogw" rt_clay@bellsouth.net Date: Tuesday, May 29, 2012, 3:39 PM I'll probably need to combine the existing help file with this manual so that everything is in one place.  Please let me know what you think.

73, de Nate >>

You can merge this Pull Request by running:

  git pull https://github.com/N0NB/so2sdr master

Or you can view, comment on it, or merge it online at:

  https://github.com/n4ogw/so2sdr/pull/2

-- Commit Summary --

  • Install 48x48 pixel icon.
  • Ignore version specific Qt Creator files
  • First draft of user manual

-- File Changes --

M .gitignore (6) A doc/README (19) A doc/images/so2sdr_bandscope.png (0) A doc/images/so2sdr_main.png (0) A doc/images/so2sdr_open.png (0) A doc/images/so2sdr_radio_ports.png (0) A doc/images/so2sdr_station_data.png (0) A doc/images/so2sdr_user_data.png (0) A doc/images/so2sdr_winkey.png (0) A doc/so2sdr.asciidoc (256) A share/icon48x48.png (0) M so2sdr/defines.h (2) M so2sdr/so2sdr.pro (4)

-- Patch Links --

  https://github.com/n4ogw/so2sdr/pull/2.patch   https://github.com/n4ogw/so2sdr/pull/2.diff


Reply to this email directly or view it on GitHub: https://github.com/n4ogw/so2sdr/pull/2

N0NB commented 12 years ago

A thought occurred to me that a shorter key/macro help file would be useful in the program with a reference to the larger manual. The full manual is likely to larger and eventually comprehensive to be read from the program.