From e6fc371e03e277870c64146ae69a4539b0f7e0f8 Mon Sep 17 00:00:00 2001 From: Mark Jessop Date: Mon, 15 Jun 2020 18:21:16 +0930 Subject: [PATCH] Update README --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 56ca065..110cadc 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,25 @@ -# High Altitude Balloon (HAB) telemetry library +# High Altitude Balloon (HAB) Telemetry Library + +This library contains software used to encode and decode telemetry used by the Project Horus High-Altitude Balloon (HAB) project (amongst other users). This software was originally developed as part of the [codec2](https://github.com/drowe67/codec2) project, but as of 2020 has been broken out into this separate project, to keep codec2 targeted at low-level voice-codec and modem development. + +This library includes the following: +* The 'HorusBinary' demodulator, a high performance 4FSK modem used for low-rate positional telemetry from HABs. More information on this modem can be found here: https://github.com/projecthorus/horusbinary (This repository will eventually be re-worked to use this library) +* The 'Wenet' demodulator, used to downlink imagery from HAB payloads. + ## Building ``` -$ git clone https://github.com/drowe67/codec2.git -$ cd codec2 && mkdir build_linux && cd build_linux && cmake ../ && make -$ cd ~ -$ git clone https://github.com/drowe67/hab.git -$ cd hab && mkdir build_linux && cd build_linux -$ cmake -DCODEC2_BUILD_DIR=~/codec2/build_linux .. +$ git clone https://github.com/projecthorus/horuslib.git +$ cd horuslib && mkdir build_linux && cd build_linux +$ cmake .. $ make ``` ## Testing ``` -$ cd hab/build_linux +$ cd horus/build_linux $ ctest ```