diff --git a/README.md b/README.md index 4375f94..5e13c30 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,20 @@ # DarkMesh Pentesting Meshtastic + +# HW +It works with Heltec v3 by default. You can rewrite it to run on other platforms too. + +# Contribution +Feel free to contribute, PRs are welcomed. If you add some features in your fork, please share it with us too. + +# Compilation +Clone the project, open it with your ide, and start to compile. It'll run into an error. Then go to managed_components/jgromes__radiolib/src/protocols/PhysicalLayer/PhysicalLayer.h and insert this to line 231: virtual ~PhysicalLayer() = default; +The PR is merged for this, but waiting for the next release. Till that, you can compile it this way. + + +This project depends on the https://github.com/htotoo/EspMeshtasticCompact you can contribute to that too! + +> **Disclaimer:** +> This project is intended for educational purposes only. Use it exclusively in controlled environments and **only** with explicit permission from all parties involved. +> +> Meshtastic is an excellent open-source project. Please respect its community and users—do not use this tool to cause harm or disrupt any Meshtastic networks. \ No newline at end of file