From d6d4ebe8cdcf69c8d670519794c3ac682bfcada2 Mon Sep 17 00:00:00 2001 From: Greg Albrecht Date: Mon, 29 Aug 2022 22:50:24 -0700 Subject: [PATCH] updating readme --- README.rst | 54 ++++++++++++++++++++++++++---------------------------- 1 file changed, 26 insertions(+), 28 deletions(-) diff --git a/README.rst b/README.rst index 3f14143..c0a5d56 100644 --- a/README.rst +++ b/README.rst @@ -2,17 +2,17 @@ Garmin inReach to Cursor on Target Gateway ****************************************** .. image:: https://raw.githubusercontent.com/ampledata/inrcot/main/docs/az-ccso-sar.jpg - :alt: Screenshot of inRCoT being used on a Search & Rescue mission in Arizona. + :alt: Screenshot of INRCOT being used on a Search & Rescue mission in Arizona. :target: https://raw.githubusercontent.com/ampledata/inrcot/main/docs/az-ccso-sar.jpg -* Pictured: Screenshot of inRCoT being used on a Search & Rescue mission in Arizona. +* Pictured: Screenshot of INRCOT being used on a Search & Rescue mission in Arizona. -The inReach to Cursor on Target Gateway (**inRCoT**) transforms Garmin inReach +The inReach to Cursor on Target Gateway (INRCOT) transforms Garmin inReach position messages into Cursor on Target (CoT) Points for display on TAK Products like ATAK, WinTAK, iTAK, et al. Single or multi-device feeds are supported. Other situational awareness products, including as RaptorX, TAKX & COPERS have been tested. -inRCoT requires a `Garmin inReach `_ device with service. +INRCOT requires a `Garmin inReach `_ device with service. Support Development @@ -58,11 +58,25 @@ the `Dingell Act Enable MapShare click to enable 'MapShare: On'. +5. Click "Feeds" and note the "Raw KML Data" URL, we'll use this URL, write it down. + +For more information on inReach KML Feeds see: https://support.garmin.com/en-US/?faq=tdlDCyo1fJ5UxjUbA9rMY8 + + +Install +======= + +INRCOT functionality is provided via a command-line tool named ``inrcot``. +To install ``inrcot``: Debian, Ubuntu, Raspbian, Raspberry OS:: @@ -83,32 +97,17 @@ Install from source:: $ python3 setup.py install -Setup -===== - -``inrcot`` uses the Garmin Explore "MapShare" feature. - -1. Login to Garmin Explore: https://explore.garmin.com/ -2. Browse to the "MY INFO" page: https://explore.garmin.com/Inbox -3. Click "Social". -4. Under MapShare > Enable MapShare click to enable 'MapShare: On'. -5. Click "Feeds" and note the "Raw KML Data" URL, we'll use this URL. - -For more information on inReach KML Feeds see: https://support.garmin.com/en-US/?faq=tdlDCyo1fJ5UxjUbA9rMY8 - - Usage ===== -The `inrcot` program has one command-line argument:: +The ``inrcot`` program has two command-line arguments:: $ inrcot -h usage: inrcot [-h] [-c CONFIG_FILE] optional arguments: -h, --help show this help message and exit - -c CONFIG_FILE, --CONFIG_FILE CONFIG_FILE - + -c CONFIG_FILE, --CONFIG_FILE Sets the path to a config file. Default: config.ini Configuration ============= @@ -127,7 +126,6 @@ Parameters:: Example Configurations ====================== - An example config:: [inrcot] @@ -177,19 +175,19 @@ Protected feeds are also supported:: Source ====== -inRCoT Source can be found on Github: https://github.com/ampledata/inrcot +INRCOT Source can be found on Github: https://github.com/ampledata/inrcot Author ====== -inRCoT is written and maintained by Greg Albrecht W2GMD oss@undef.net +INRCOT is written and maintained by Greg Albrecht W2GMD oss@undef.net https://ampledata.org/ Copyright ========= -inRCoT is Copyright 2022 Greg Albrecht +INRCOT is Copyright 2022 Greg Albrecht License