From e39b18dfa42f31e6be0b41b26442192edb7c0591 Mon Sep 17 00:00:00 2001 From: Lucas Tindall Date: Mon, 18 Dec 2023 11:01:20 -0800 Subject: [PATCH 1/2] Fix typos. Add docs links. --- README.md | 15 +++++++++++++-- docs/4-OPERATION.md | 2 +- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 70a1a3f3..ab8d6338 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ over a network. gamutRF provides tools to work with I/Q sample recordings, and to also record GPS location/compass metadata for the system itself. gamutRF typically runs on networks of Raspberry Pi4s, but can also run on x86 machines, and is based on gnuradio. -See also [instructions on how to build a gamutRF system](docs/BUILD.md). +See also [instructions on how to build a gamutRF system](docs/3-BUILD.md). ## Scanner theory of operation @@ -25,7 +25,18 @@ As there will almost certainly be more signals than workers available, sigfinder ## Build and Operating gamutRF -See the [build doc](docs/2-BUILD.md) for instruction on setting up a GamutRF system. Next see the [operating instructions](docs/4-OPERATION.md) for instructions on operating GamutRF. +See the [build doc](docs/3-BUILD.md) for instruction on setting up a GamutRF system. Next see the [operating instructions](docs/4-OPERATION.md) for instructions on operating GamutRF. + +## Documentation + +[1 - Introduction](docs/1-INTRODUCTION.md) +[2 - System Overview](docs/2-SYSTEM_OVERVIEW.md) +[3 - Build](docs/3-BUILD.md) +[4 - Operation](docs/4-OPERATION.md) +[5 - ML Tooling](docs/5-ML_TOOLING.md) +[6 - Testing](docs/6-TESTING.md) +[7 - Troubleshooting](docs/7-TROUBLESHOOTING.md) +[AIRT Support](docs/README-airt.md) ## Contributing diff --git a/docs/4-OPERATION.md b/docs/4-OPERATION.md index e286740a..6bc446a3 100644 --- a/docs/4-OPERATION.md +++ b/docs/4-OPERATION.md @@ -94,7 +94,7 @@ until a new RPC (whether rssi or record) is received. ## Utility Functions -Below are some untility functions for working with GamutRF and the collected IQ files. +Below are some utility functions for working with GamutRF and the collected IQ files. ### Running GamutRF pipeline from IQ file From 2507034f8a207b0968b28a4770d8c7beaf1f2151 Mon Sep 17 00:00:00 2001 From: Lucas Tindall Date: Mon, 18 Dec 2023 11:03:15 -0800 Subject: [PATCH 2/2] newlines --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ab8d6338..6a986078 100644 --- a/README.md +++ b/README.md @@ -29,14 +29,14 @@ See the [build doc](docs/3-BUILD.md) for instruction on setting up a GamutRF sys ## Documentation -[1 - Introduction](docs/1-INTRODUCTION.md) -[2 - System Overview](docs/2-SYSTEM_OVERVIEW.md) -[3 - Build](docs/3-BUILD.md) -[4 - Operation](docs/4-OPERATION.md) -[5 - ML Tooling](docs/5-ML_TOOLING.md) -[6 - Testing](docs/6-TESTING.md) -[7 - Troubleshooting](docs/7-TROUBLESHOOTING.md) -[AIRT Support](docs/README-airt.md) +[1 - Introduction](docs/1-INTRODUCTION.md) +[2 - System Overview](docs/2-SYSTEM_OVERVIEW.md) +[3 - Build](docs/3-BUILD.md) +[4 - Operation](docs/4-OPERATION.md) +[5 - ML Tooling](docs/5-ML_TOOLING.md) +[6 - Testing](docs/6-TESTING.md) +[7 - Troubleshooting](docs/7-TROUBLESHOOTING.md) +[AIRT Support](docs/README-airt.md) ## Contributing