From 7e9da82b293ffe22e1c71cdec3c092e32618d501 Mon Sep 17 00:00:00 2001 From: "Martin Bernardi (PC)" Date: Tue, 7 Jul 2020 09:04:50 -0300 Subject: [PATCH] Documentation about OSX compilation and IQ files (issue #20) --- docs/development.md | 39 +++++++++++++++++++++++++++++++++------ docs/download.md | 4 ++-- docs/guide.md | 3 +++ docs/usage.md | 8 ++++++-- src/gui/gui.rs | 10 +++++----- 5 files changed, 49 insertions(+), 15 deletions(-) diff --git a/docs/development.md b/docs/development.md index 6ecf149..dd6af3a 100644 --- a/docs/development.md +++ b/docs/development.md @@ -169,6 +169,10 @@ Build with `--release`, Rust does some optimizations and it works faster. - `cargo build --release`. +Run with: + + ./target/release/noaa-apt + ### GNU/Linux portable I can't make `gtk-rs` to work with the `x86_64-unknown-linux-musl` target, so @@ -198,13 +202,34 @@ GUI version and the GUI .deb package. Also I build the Raspberry Pi versions ### Mac / OSX -- Install [rustup](https://rustup.rs/). The 'unix installer' is fine for Macs. +This is a summary of +[this extensive installation guide](https://publiclab.org/notes/sashae/07-02-2020/how-to-compile-noaa-apt-1-2-0-on-mac) -- Install dependencies via [Homebrew](https://brew.sh/). I'm not entirely sure - if these are enough: - `brew install gtk+3 adwaita-icon-theme openssl`. +- Install [rustup](https://rustup.rs/): -- `cargo build --release`. + curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh + source $HOME/.cargo/env + +- Install dependencies via [Homebrew](https://brew.sh/). + + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)" + brew install gtk+3 adwaita-icon-theme openssl + +- Download the [source code zip file](https://github.com/martinber/noaa-apt/releases) + and extract it somewhere. + +- Move to the downloaded folder + + cd Downloads/noaa-apt-1.2.0/ + +- Compile + + export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig/ + cargo build --release + +Run with: + + ./target/release/noaa-apt ### Windows portable @@ -374,7 +399,9 @@ If you want to disable this you can do it from the - Dirk Lison: Testing and filename guessing for WXtoIMG. -- Grant T. Olson: OSX build instructions. +- Grant T. Olson: Early OSX build instructions + +- Sasha Engelmann and Bill Liles: [Further OSX build instructions](https://publiclab.org/notes/sashae/07-02-2020/how-to-compile-noaa-apt-1-2-0-on-mac). - FMighty: Helped with cross compilation to Raspberry Pi. diff --git a/docs/download.md b/docs/download.md index ad985ad..0189ccb 100644 --- a/docs/download.md +++ b/docs/download.md @@ -77,11 +77,11 @@ After downloading and installing, visit [the Usage page](./usage.html). ### OSX -- [Compile it yourself](./development.html#compilation). +- [Compile it yourself following these instructions](./development.html#compilation). ### Something else? -- [Compile it yourself](./development.html#compilation). +- [Compile it yourself following these instructions](./development.html#compilation). ## Dependencies diff --git a/docs/guide.md b/docs/guide.md index d77f171..980a693 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -21,6 +21,9 @@ cheap. Read this to get started. This is a guide about how to receive images, if you want information about how to use noaa-apt check the [Usage](./usage.html) page. +Check [this tutorial](https://publiclab.org/notes/sashae/06-26-2020/diy-satellite-ground-station) +too. It is meant for another decoder, WXtoImg, but it has useful information. + ## Important things to know - NOAA **images are black and white**. People on the internet share color diff --git a/docs/usage.md b/docs/usage.md index b393856..874ebef 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -79,8 +79,12 @@ to guess the satellite name and recording time from the filename, and then it will download an updated TLE file with orbit information from the internet. If the filename has a custom name, this can fail. So you will have to check the -recording time and choose a satellite. See below to edit the configuration file -to "teach" noaa-apt how read your filenames. +recording time and choose a satellite. Below there are instructions on how to +edit the configuration file and "teach" noaa-apt how read your filenames. + +IQ files are not supported, these files should be FM demodulated into WAVs +first. SDR# and GQRX can load and demodulate IQ files with a specific format, +[more information here](https://github.com/martinber/noaa-apt/issues/20). ### GUI diff --git a/src/gui/gui.rs b/src/gui/gui.rs index c65b413..3ccb5cc 100644 --- a/src/gui/gui.rs +++ b/src/gui/gui.rs @@ -462,11 +462,11 @@ fn build_system_menu(widgets: &Widgets) { dialog.add_credit_section("Thank you", &[ "RTL-SDR.com", "pietern", "Ossi Herrala", "Arcadie Z.", - "Nodraak", "Dirk Lison", "Grant T. Olson", "FMighty", - "Sylogista", "Peter Vogel", "wren84", "Florentin314", - "Gagootron", "xxretartistxx", "unknownantipatriot", - "BGNLouie", "nosduh2", "samarrangepas", "KiwiEntropy", - "budude2", "K2SDR", "K6KZO", "TheLAX18" + "Nodraak", "Dirk Lison", "Grant T. Olson", "Sasha Engelmann", + "Bill Liles", "FMighty", "Sylogista", "Peter Vogel", + "wren84", "Florentin314", "Gagootron", "xxretartistxx", + "unknownantipatriot", "BGNLouie", "nosduh2", "samarrangepas", + "KiwiEntropy", "budude2", "K2SDR", "K6KZO", "TheLAX18" ]); dialog.set_website_label(Some("noaa-apt website"));