Convert SDR READMEs to Markdown.
Change-Id: I904d82d13563d0fe907dec80d2ad2adc54a197d8
diff --git a/bandpass_recorder/README b/bandpass_recorder/README
index 44c3072..b4a66b6 100644
--- a/bandpass_recorder/README
+++ b/bandpass_recorder/README
@@ -1,26 +1,27 @@
-Interference Recorder Script 1.0
-===============================================================================
+# Interference Recorder Script
-This script takes in a filename as in input and opens a gui which allows
+This script takes in a filename as in input and opens a GUI which allows
the user to adjust the frequency, bandwidth, gain, and record time. Upon
closing the GUI, the script will automatically begin recording for the
specified time.
Usage:
-./bandpass_recorder.py filename
--------------------------------------------------------------------------------
-Requirements:
+```
+./bandpass_recorder.py filename
+```
+
+## Requirements:
- USRP Software Defined Radio
- GNURadio and UHD Driver
-- "bandpass_recorder_file.py" and "bandpass_recorder_gui.py"
+- `bandpass_recorder_file.py` and `bandpass_recorder_gui.py`
--------------------------------------------------------------------------------
-Changing radio behaviour:
-The recorder behaviour can be changed by modifying "bandpass_recorder_file.py"
-or "bandpass_recorder_gui.py" in 2 ways:
-1) Editing the files directly
-2) Opening "bandpass_recorder_file.grc" or "bandpass_recorder_gui.grc"
+## Changing radio behavior
+The recorder behavior can be changed by modifying `bandpass_recorder_file.py`
+or `bandpass_recorder_gui.py` in 2 ways:
+
+1. Editing the files directly
+2. Opening `bandpass_recorder_file.grc` or `bandpass_recorder_gui.grc`
with gnuradio-companion and regenerating the python files.
Note: the output of bandpass_recorder_file.py must be recorder.out as
@@ -28,13 +29,12 @@
will output the data stream to recorder.out and it will then be renamed
to the specified filename.
-===============================================================================
-Signal Analysis Tool
+# Signal Analysis Tool
-"signal_analyzer.py" can be used to analyze recordings in order to extract
+`signal_analyzer.py` can be used to analyze recordings in order to extract
parameters from the data files created by the recorder script.
-Use "./signal_analyzer.py -h" to view options
+Use `./signal_analyzer.py -h` to view options
Note that large window/display values can crash your system as they are very
memory intensive. Window values should be less than or equal to 1e8 and
diff --git a/signal_generator/README b/signal_generator/README
index 3904791..4c67762 100644
--- a/signal_generator/README
+++ b/signal_generator/README
@@ -1,5 +1,5 @@
-Signal Generator Script 1.0
-===============================================================================
+# Signal Generator Script
+
This script takes command line arguments to broadcast the sum of various signals
with differing strengths. The script takes in arguments by specifying a type of
signal to broadcast followed by the corresponding parameters for that signal.
@@ -7,24 +7,24 @@
The script currently supports 4 types of signals:
-1) It can broadcast a signal from a raw data file which is generated by a file
- source in GNURadio and by the bandpass_recorder.py script included in this
- project.
-2) Periodic - Generates a single sine wave at a specified offset from the
- center frequency and should show up as a spike in the fourier transform.
-3) Wifi - Mimics a wifi signal. The type-specific signals like this require
- that a config file be specified. The parameters of this signal can be
- generated using signal_analyzer.py. It also requires a signal profile stored
- in a .npy file.
-4) Bluetooth - Mimics a Bluetooth signal. See Wifi for description.
+1. It can broadcast a signal from a raw data file which is generated by a file
+ source in GNURadio and by the bandpass_recorder.py script included in this
+ project.
+2. Periodic - Generates a single sine wave at a specified offset from the
+ center frequency and should show up as a spike in the fourier transform.
+3. Wifi - Mimics a wifi signal. The type-specific signals like this require
+ that a config file be specified. The parameters of this signal can be
+ generated using signal_analyzer.py. It also requires a signal profile stored
+ in a .npy file.
+4. Bluetooth - Mimics a Bluetooth signal. See Wifi for description.
-Usage: signal_generator.py [options]
+Usage: `signal_generator.py [options]`
-To print usage info use "./signal_generator.py -h" option.
+To print usage info use `./signal_generator.py -h` option.
Note: If you are playing from a file and are getting Underruns (U), try moving
the file to local storage.
A set of useful recordings and signal profiles have been placed at
-"/google/data/rw/teams/gfiber/sdr/recordings" that can be used for testing or
+`/google/data/rw/teams/gfiber/sdr/recordings` that can be used for testing or
other purposes.
diff --git a/udp_test/README b/udp_test/README
index c66c06c..b96f82a 100644
--- a/udp_test/README
+++ b/udp_test/README
@@ -1,5 +1,5 @@
-UDP Test Tool
-===============================================================================
+# UDP Test Tool
+
The UDP Test tool is a connection testing tool that is similar to iperf. This
tool has been created partially due to limitations in iperf. This tool is
designed to test downstream throughput and measures the speed of a connection
diff --git a/utils/README b/utils/README
index 78fa424..093e9ee 100644
--- a/utils/README
+++ b/utils/README
@@ -1,12 +1,11 @@
-Wifi Torpedo Utils
-===============================================================================
+# Wifi Torpedo Utils
+
These are a few utilities that have been useful in development of the tools.
The .grc files can be opened and used with gnuradio-companion.
-file-player.grc : This is a tool that simply reads a file and plays it over the
- USRP and then listens on the same antenna. This allows you to view the signal
- that is stored in the file as if it were being broadcasted by another source.
+`file-player.grc`: This is a tool that simply reads a file and plays it over the
+USRP and then listens on the same antenna. This allows you to view the signal
+that is stored in the file as if it were being broadcasted by another source.
-test_signal.grc : This is a simple tool that broadcasts a sine signal and
- records it to verify that the USRP is functioning properly.
-
+`test_signal.grc`: This is a simple tool that broadcasts a sine signal and
+records it to verify that the USRP is functioning properly.
