Skip to content

Commit a7391b4

Browse files
committed
Move documentation to doc subdirectory.
Add/update README.md files.
1 parent 0137107 commit a7391b4

11 files changed

+66
-1
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Version 1.2 decodes more than 1000 error-free frames from [WA8LMF TNC Test CD](h
4949

5050
### Windows ###
5151

52-
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.
52+
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.
5353

5454
### Linux - short version for the impatient ###
5555

doc/APRS-Telemetry-Toolkit.pdf

1.23 MB
Binary file not shown.
File renamed without changes.

doc/APRStt-interface-for-SARTrack.pdf

743 KB
Binary file not shown.

doc/README.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Documentation for Dire Wolf #
2+
3+
4+
## Essential Reading ##
5+
6+
- [User Guide](User-Guide.pdf)
7+
8+
This is your primary source of information about installation, operation, and configuration.
9+
10+
- [Raspberry Pi APRS](Raspberry-Pi-APRS.pdf)
11+
12+
The Raspberry Pi has some special considerations that
13+
make it different from other generic Linux systems.
14+
Start here if using the Raspberry Pi, Beaglebone Black, cubieboard2, or similar single board computers.
15+
16+
17+
## Application Notes ##
18+
19+
These dive into more detail for specialized topics or typical usage scenarios.
20+
21+
22+
- [APRStt Implementation Notes](APRStt-Implementation-Notes.pdf)
23+
24+
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.
25+
This document explains how the APRStt concept was implemented in the Dire Wolf application.
26+
27+
- [APRStt Interface for SARTrack](APRStt-Interface-for-SARTrack.pdf)
28+
29+
This example illustrates how APRStt can be integrated with other applications such as SARTrack, APRSISCE/32, YAAC, or Xastir.
30+
31+
32+
- [Raspberry Pi SDR IGate](Raspberry-Pi-SDR-IGate.pdf)
33+
34+
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.
35+
36+
- [APRS Telemetry Toolkit](APRS-Telemetry-Toolkit.pdf)
37+
38+
Describes scripts and methods to generate telemetry.
39+
Includes a complete example of attaching an analog to
40+
digital converter to a Raspberry Pi and transmitting
41+
a measured voltage.
42+
43+
## Miscellaneous ##
44+
45+
46+
- [A Better APRS Packet Demodulator, part 1, 1200 baud](A-Better-APRS-Packet-Demodulator-Part-1-1200-baud.pdf)
47+
48+
Sometimes it's a little mystifying why an
49+
APRS / AX.25 Packet TNC will decode some signals
50+
and not others. A weak signal, buried in static,
51+
might be fine while a nice strong clean sounding
52+
signal is not decoded. Here we will take a brief
53+
look at what could cause this perplexing situation
54+
and a couple things that can be done about it.
55+
56+
57+
58+
- [A Better APRS Packet Demodulator, part 2, 9600 baud](A-Better-APRS-Packet-Demodulator-Part-2-9600-baud.pdf)
59+
60+
In the first part of this series we discussed 1200 baud audio frequency shift keying (AFSK). The mismatch
61+
between FM transmitter pre-emphasis and the
62+
receiver de-emphasis will
63+
cause the amplitudes of the two tones to be different.
64+
This makes it more difficult to demodulate them accurately.
65+
9600 baud operation is an entirely different animal. ...
File renamed without changes.
File renamed without changes.

doc/Raspberry-Pi-SDR-IGate.pdf

516 KB
Binary file not shown.

User-Guide.pdf doc/User-Guide.pdf

File renamed without changes.

0 commit comments

Comments
 (0)