From 1353959a60a657cf5122d2d9e305b089bd254548 Mon Sep 17 00:00:00 2001 From: Nyan Helsing <1523817+NyanHelsing@users.noreply.github.com> Date: Sat, 25 Jan 2025 15:32:04 -0500 Subject: [PATCH] Create QUICKSTART.md --- QUICKSTART.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 QUICKSTART.md diff --git a/QUICKSTART.md b/QUICKSTART.md new file mode 100644 index 0000000000..beba4b1eac --- /dev/null +++ b/QUICKSTART.md @@ -0,0 +1,47 @@ +# Quick Starts for common platforms + +## Linux CLI-Only QuickStart + +### Starting from the home dir, Clone this repository and `cd` into it +``` +cd ~ +git clone git@github.com:ripplebiz/MeshCore.git +cd MeshCore +``` + +### Install deps: +``` +platformio pkg install +``` + +### If installing from cli, ensure arduino embed package is installed: +``` +platformio pkg install -t platformio/framework-arduino-mbed +``` + +### Need to patch some libs as per https://learn.rakwireless.com/hc/en-us/articles/26687276346775-How-To-Perform-Installation-of-Board-Support-Package-in-PlatformIO +``` +cd ../.platformio +wget https://raw.githubusercontent.com/RAKWireless/WisBlock/master/PlatformIO/RAK_PATCH.zip +unar RAK_PATCH.zip +cd RAK_PATCH +python3 ./rak_patch.py +``` + +We should see something like: +``` +~/.platformio/RAK_PATCH via 🐍 v3.12.8 +❯ python3 ./rak_patch.py +Patching RAK4631 +Patched RAK4631 +Patching RAK11200 +Patched RAK11200 +Patching RAK11310 +Patched RAK11310 +Patch done, check output if successful +``` + +### Flash it to a T-Deck +``` +platformio run -e ???? +```