diff --git a/README.md b/README.md index c1d92f0c5..b9fe3b8b5 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ [![main](https://github.com/swift-nav/swift-toolbox/actions/workflows/main.yml/badge.svg)](https://github.com/swift-nav/swift-toolbox/actions/workflows/main.yml) +## Introduction + +The Swift Console is a Graphical User Interface (GUI) program that provides a visual representation of the output from Swift Navigation GNSS receivers. The console displays information and enables the user to adjust the hardware settings. It runs on Windows, Linux, and macOS platforms. + +This is the open source repository for code that implements the console. **Releases on this page are provisional and _NOT_ official releases.** For official (and supported) releases please see visit [our downloads page](https://swiftnav.com/latest/swift-console) for the console and see [our guide](https://support.swiftnav.com/support/solutions/articles/44001903699-installing-swift-console) on how to install the console. + +![main](docs/swift-console.png) + ## Setup Install Rust: https://rustup.rs/ diff --git a/docs/swift-console.png b/docs/swift-console.png new file mode 100644 index 000000000..d0be0ab96 Binary files /dev/null and b/docs/swift-console.png differ