Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs typo #1050

Merged
merged 2 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/4-OPERATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading