From 01d1a5ab48c5c530b271daaf9abff24280541f0d Mon Sep 17 00:00:00 2001 From: Kevin Hester Date: Wed, 6 Jan 2021 16:14:35 +0800 Subject: [PATCH] add clarification on how to run the tool --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ed10f96..100d5a6 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ For the rough notes/implementation plan see [TODO](https://github.com/meshtastic This pip package will also install a "meshtastic" command line executable, which displays packets sent over the network as JSON and lets you see serial debugging information from the meshtastic devices. The source code for this tool is also a good [example](https://github.com/meshtastic/Meshtastic-python/blob/master/meshtastic/__main__.py) of a 'complete' application that uses the meshtastic python API. +NOTE: This command is not run inside of python, you run it from your operating system shell prompt directly. If when you type "meshtastic" it doesn't find the command and you are using Windows: Check that the python "scripts" directory [is in your path](https://datatofish.com/add-python-to-windows-path/). + To display a (partial) list of the available commands: ``` meshtastic -h