From 2888e5ad078bc878a3193a0bcae9b0bef905dbb0 Mon Sep 17 00:00:00 2001 From: Mark Jessop Date: Tue, 17 Jul 2018 23:01:01 +0930 Subject: [PATCH] Update readme with screenshot. --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cadaef..96f9893 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,17 @@ **Note: This is a work-in-progress. Not all of the features below are functional.** -This folder contains code to display payload (and chase car!) position data in a web browser. +This folder contains code to display payload (and chase car!) position data in a web browser: + +![ChaseMapper Screenshot](https://github.com/projecthorus/chasemapper/raw/master/doc/chasemapper.jpg) For this to run, you will need the horuslib library installed. Refer to the [Installation guide](https://github.com/projecthorus/horus_utils/wiki/1.-Dependencies-&-Installation). +You also need flask, and flask-socketio, which can be installed using pip: +``` +$ sudo pip install flask flask-socketio +``` + This is very much a work-in-progress, with much to be completed. For now, the following works: To listen for payload data from OziMux (i.e. on UDP:localhost:8942): @@ -29,6 +36,8 @@ Once compiled and installed, you will need to: * Copy the 'pred' binary into this directory. If using the Windows build, this will be `pred.exe`; under Linux/OSX, just `pred`. * [Download wind data](https://github.com/darksidelemm/cusf_predictor_wrapper/#3-getting-wind-data) for your area of interest, and place the .dat files into the gfs subdirectory. +TODO: Update below doc. Most settings are set from the web interface. + The following additional arguments can then be used: ```