Skip to content

docs : add local development guide link to README #897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
shalini-s7 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs : add local development guide link to README #897

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94d17ba
updated README
shalini-s7 Jan 29, 2026
5b615ec
updated
shalini-s7 Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ Events are delivered using a publish-subscribe model, and you can subscribe to o
This library and CLI has gone without a consistent maintainer for a while, and there's many improvements that could be made. We're all volunteers here and help is extremely appreciated, whether in implementing your own needs or helping maintain the library and CLI in general.

If you're interested in contributing but don't have specific things you'd like to work on, look at the roadmap below!
## Local Development

If you would like to contribute to the Meshtastic Python library or CLI, we recommend setting up a local development environment.

A detailed, step-by-step guide for running the project from source — including dependency installation with Poetry, initializing git submodules, running the CLI locally, and executing tests — is available here:

👉 **Local Development Guide for Meshtastic Python (coming soon)**
https://meshtastic.org/docs/development/python/local-dev/


This guide is intended for contributors who want to develop, debug, or test changes before submitting a pull request.

## Roadmap

Expand Down