diff --git a/README.md b/README.md index 2ad2677..de866b5 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ Version 1.2 decodes more than 1000 error-free frames from [WA8LMF TNC Test CD](h ### Windows ### -Go to the [releases page](releases/). Download a zip file with "win" in its name, unzip it, and run direwolf.exe from a command window. +Go to the [releases page](https://github.com/wb2osz/direwolf/releases). Download a zip file with "win" in its name, unzip it, and run direwolf.exe from a command window. ### Linux - short version for the impatient ### diff --git a/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf b/doc/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf similarity index 100% rename from A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf rename to doc/A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf diff --git a/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf b/doc/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf similarity index 100% rename from A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf rename to doc/A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf diff --git a/doc/APRS-Telemetry-Toolkit.pdf b/doc/APRS-Telemetry-Toolkit.pdf new file mode 100644 index 0000000..06b62e4 Binary files /dev/null and b/doc/APRS-Telemetry-Toolkit.pdf differ diff --git a/APRStt-Implementation-Notes.pdf b/doc/APRStt-Implementation-Notes.pdf similarity index 100% rename from APRStt-Implementation-Notes.pdf rename to doc/APRStt-Implementation-Notes.pdf diff --git a/doc/APRStt-interface-for-SARTrack.pdf b/doc/APRStt-interface-for-SARTrack.pdf new file mode 100644 index 0000000..69f3c14 Binary files /dev/null and b/doc/APRStt-interface-for-SARTrack.pdf differ diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..92ff719 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,65 @@ +# Documentation for Dire Wolf # + + +## Essential Reading ## + +- [User Guide](User-Guide.pdf) + + This is your primary source of information about installation, operation, and configuration. + +- [Raspberry Pi APRS](Raspberry-Pi-APRS.pdf) + + The Raspberry Pi has some special considerations that + make it different from other generic Linux systems. + Start here if using the Raspberry Pi, Beaglebone Black, cubieboard2, or similar single board computers. + + +## Application Notes ## + +These dive into more detail for specialized topics or typical usage scenarios. + + +- [APRStt Implementation Notes](APRStt-Implementation-Notes.pdf) + + Very few hams have portable equipment for APRS but nearly everyone has a handheld radio that can send DTMF tones. APRStt allows a user, equipped with only DTMF (commonly known as Touch Tone) generation capability, to enter information into the global APRS data network. + This document explains how the APRStt concept was implemented in the Dire Wolf application. + +- [APRStt Interface for SARTrack](APRStt-Interface-for-SARTrack.pdf) + + This example illustrates how APRStt can be integrated with other applications such as SARTrack, APRSISCE/32, YAAC, or Xastir. + + +- [Raspberry Pi SDR IGate](Raspberry-Pi-SDR-IGate.pdf) + + It's easy to build a receive-only APRS Internet Gateway (IGate) with only a Raspberry Pi and a software defined radio (RTL-SDR) dongle. Here’s how. + +- [APRS Telemetry Toolkit](APRS-Telemetry-Toolkit.pdf) + + Describes scripts and methods to generate telemetry. + Includes a complete example of attaching an analog to + digital converter to a Raspberry Pi and transmitting + a measured voltage. + +## Miscellaneous ## + + +- [A Better APRS Packet Demodulator, part 1, 1200 baud](A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf) + + Sometimes it's a little mystifying why an +APRS / AX.25 Packet TNC will decode some signals +and not others. A weak signal, buried in static, +might be fine while a nice strong clean sounding +signal is not decoded. Here we will take a brief +look at what could cause this perplexing situation +and a couple things that can be done about it. + + + +- [A Better APRS Packet Demodulator, part 2, 9600 baud](A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf) + + In the first part of this series we discussed 1200 baud audio frequency shift keying (AFSK). The mismatch + between FM transmitter pre-emphasis and the + receiver de-emphasis will + cause the amplitudes of the two tones to be different. + This makes it more difficult to demodulate them accurately. + 9600 baud operation is an entirely different animal. ... \ No newline at end of file diff --git a/Raspberry-Pi-APRS-Tracker.pdf b/doc/Raspberry-Pi-APRS-Tracker.pdf similarity index 100% rename from Raspberry-Pi-APRS-Tracker.pdf rename to doc/Raspberry-Pi-APRS-Tracker.pdf diff --git a/Raspberry-Pi-APRS.pdf b/doc/Raspberry-Pi-APRS.pdf similarity index 100% rename from Raspberry-Pi-APRS.pdf rename to doc/Raspberry-Pi-APRS.pdf diff --git a/doc/Raspberry-Pi-SDR-IGate.pdf b/doc/Raspberry-Pi-SDR-IGate.pdf new file mode 100644 index 0000000..da1f6b0 Binary files /dev/null and b/doc/Raspberry-Pi-SDR-IGate.pdf differ diff --git a/User-Guide.pdf b/doc/User-Guide.pdf similarity index 100% rename from User-Guide.pdf rename to doc/User-Guide.pdf