From fb70f644e5325fa1776d95d62355d95e2caa30f7 Mon Sep 17 00:00:00 2001 From: madeofstown <33820964+madeofstown@users.noreply.github.com> Date: Tue, 19 Aug 2025 19:08:38 -0700 Subject: [PATCH] Update README.md Change install procedure to mitigate broken submodule --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 52f1c1c..571b281 100644 --- a/README.md +++ b/README.md @@ -52,16 +52,23 @@ Requires **`python3.11`** or above. Clone the repo from GitHub: ```bash -git clone --recurse-submodules https://github.com/pablorevilla-meshtastic/meshview.git +git clone https://github.com/pablorevilla-meshtastic/meshview.git ``` > **NOTE** -> It is important to include the `--recurse-submodules` flag or the meshtastic protobufs won't be included. +> DO NOT include the `--recurse-submodules` flag! There appears to be a broken submodule in the meshtastic/python repo. -Create a Python virtual environment: +Initialize submodule (non-recursively) and create symlink: ```bash cd meshview +git submodule update --init +ln -s python/meshtastic/protobuf meshtastic/protobuf +``` +Create a Python virtual environment: + +from the meshview directory... +```bash python3 -m venv env ```