From 55b6f6069faf2d0c1bd9b47003bd56dac2e8dc67 Mon Sep 17 00:00:00 2001
From: andermatt64 <andy@airframes.io>
Date: Sun, 29 Oct 2023 19:33:12 -0400
Subject: [PATCH] Update README

---
 README.md            | 15 ++++++++++++++-
 build_deb_package.sh |  2 +-
 2 files changed, 15 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index a6d17a5..7b90088 100644
--- a/README.md
+++ b/README.md
@@ -12,6 +12,10 @@ Notable features:
 
 For Ubuntu/Debian, check out GitHub Actions for `amd64` packages.
 
+## Requirements
+ * Install [dumphfdl](https://github.com/szpajder/dumphfdl)
+ * Install [dumpvdl2](https://github.com/szpajder/dumpvdl2)
+ 
 ## Building
  1. Install a stable [Rust](https://www.rust-lang.org/learn/get-started) toolchain. Make sure the `cargo` command is in `PATH` environment variable after completion.
  2. Make sure to install `SoapySDR` development files either by compiling manually or installing the package provided by your Linux distribution's package manager.
@@ -26,6 +30,15 @@ cargo build --release
  5. Compiled binary should be built in `./target/release/xng`
 
 ## How To Run
+### No fuss "I want to run this to feed HFDL now"
+If you've followed the previous instructions and the current directory is the `xng` repo root, run the following (assuming an Airspy HF SDR):
+```bash
+./target/release/xng hfdl -vvv --systable /etc/systable.conf --sample-rate 512000 --start-band-contains 8000 --use-airframes-gs-map --method random --only-listen-on-active --feed-airframes -- --soapysdr driver=airspyhf --station-id "MY-STATION-ID"
+```
+
+This quick example starts a HFDL listening session using the SoapySDR `airspyhf` driver to listen to all active HFDL stations in the range of 8Mhz. While feeding to Airframes as station `MY-STATION-ID`.
+
+### Fancy options with ElasticSearch backend
 **NOTE:** If you want to index received frames to a local ElasticSearch instance, run the following command first:
 ```bash
 xng init_es --elastic "http://my-es-server:9200" --elastic-index xng_acars_db
@@ -40,7 +53,7 @@ Following example starts a HFDL listening session on the 8MHz band (as determine
  * Use the SoapySDR `airspyhf` driver
 
 ```bash
-xng hfdl -vvv --systable /etc/systable.conf --sample-rate 512000 --start-band-contains 8000 --use-airframes-gs-map --method random --only-listen-on-active --state-db xng_state.db --feed-airframes --elastic "https://my-es-server:9200" --elastic-index xng_acars_db  -- --soapysdr driver=airspyhf --station-id "MY-STATION-ID"
+xng hfdl -vvv --systable /etc/systable.conf --sample-rate 512000 --start-band-contains 8000 --use-airframes-gs-map --method random --only-listen-on-active --feed-airframes --elastic "https://my-es-server:9200" --elastic-index xng_acars_db  -- --soapysdr driver=airspyhf --station-id "MY-STATION-ID"
 ```
 
 ## Web API Endpoints
diff --git a/build_deb_package.sh b/build_deb_package.sh
index e92d325..5d495af 100755
--- a/build_deb_package.sh
+++ b/build_deb_package.sh
@@ -9,7 +9,7 @@ DEB_PKG_NAME=xng-${DEB_PKG_VERSION}-${DEB_ARCH}
 mkdir -p ${DEB_BUILD_ROOT}/${DEB_PKG_NAME}/DEBIAN
 mkdir -p ${DEB_BUILD_ROOT}/${DEB_PKG_NAME}/usr/bin
 
-cp $(pwd)/target/release/${DEB_PKG_NAME} ${DEB_BUILD_ROOT}/${DEB_PKG_NAME}/usr/bin
+cp $(pwd)/target/release/xng ${DEB_BUILD_ROOT}/${DEB_PKG_NAME}/usr/bin
 sed -e s/CURRENT_ARCH/${DEB_ARCH}/ $(pwd)/packaging/control > ${DEB_BUILD_ROOT}/${DEB_PKG_NAME}/DEBIAN/control
 
 pushd ${DEB_BUILD_ROOT} && \