From 3fd50bf96e7fa1680fbaffa428446c698298cd50 Mon Sep 17 00:00:00 2001 From: Mike Kinney Date: Thu, 10 Mar 2022 17:49:09 -0800 Subject: [PATCH] re-write the installation instructions for m-flasher --- docs/getting-started/meshtastic-flasher.md | 64 +++++++++++++++++++++- 1 file changed, 62 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/meshtastic-flasher.md b/docs/getting-started/meshtastic-flasher.md index 34d19efb..234eadf8 100644 --- a/docs/getting-started/meshtastic-flasher.md +++ b/docs/getting-started/meshtastic-flasher.md @@ -10,11 +10,13 @@ import TabItem from '@theme/TabItem'; ## Overview -Meshtastic Flasher is a graphical user interface for flashing [supported devices](/docs/hardware) with Meshtastic. +Meshtastic Flasher (aka m-flasher) is a graphical user interface for flashing [supported devices](/docs/hardware) with Meshtastic. +The following operating systems are currently supported: Windows, Mac, and Ubuntu. ## Prerequisites -Install Meshtastic Flasher by either [downloading the executable file](https://github.com/meshtastic/Meshtastic-gui-installer/releases) or installing using `pip`. The following operating systems are currently supported: Windows, Mac, and Ubuntu. +* Python 3 is required +* Download the App (Windows or Mac) ### Check Data Cable @@ -56,8 +58,66 @@ Navigate to `Device Manager > Ports (COM & LPT)`. You should see something like +### Install App + +This is the preferred installation method for `meshtastic-flasher`. + + + + +```bash title="Install Meshtastic Flasher" +python3 --version +# ensure you are using at least python v3.6 +# change to a directory where you want to create a python virtual environment +mkdir some_dir +cd some_dir +# if the following command fails, it might tell you what package to install +python3 -m venv venv +# activate the python virtual environment +source venv/bin/activate +# your prompt should change - it should include "(venv) in the front +# upgrade pip +pip install --upgrade pip +pip install meshtastic-flasher +``` + +```bash title="Running Meshtastic Flasher" +meshtastic-flasher +``` + + + + +This application requires that you have `python3` installed. There are many ways to do this: + +* install from https://www.python.org/downloads/macos/ , or +* use brew - see https://brew.sh/ , or +* use macports - see https://www.macports.org/ + +To install `meshtastic-flasher`, download Meshtastic-flasher.app.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/macapp1.0.0 , unzip and drag to /Applications. + + + + +To install python3, see https://www.python.org/downloads/windows/ + +To install meshtastic-flasher, download meshtastic-flasher.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/winapp1.0.0, unzip and run. + + + + + ### Install using `pip` +This option is typically for developers. +